@sapui5/types 1.113.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/LICENSE.txt +35 -0
- package/README.md +35 -0
- package/package.json +23 -0
- package/types/index.d.ts +67 -0
- package/types/sap.apf.d.ts +1026 -0
- package/types/sap.ca.ui.d.ts +14005 -0
- package/types/sap.chart.d.ts +4815 -0
- package/types/sap.collaboration.d.ts +2704 -0
- package/types/sap.esh.search.ui.d.ts +1595 -0
- package/types/sap.f.d.ts +20085 -0
- package/types/sap.fe.core.d.ts +1508 -0
- package/types/sap.fe.macros.d.ts +975 -0
- package/types/sap.fe.navigation.d.ts +917 -0
- package/types/sap.fe.templates.d.ts +522 -0
- package/types/sap.fe.test.d.ts +3533 -0
- package/types/sap.feedback.ui.d.ts +3 -0
- package/types/sap.gantt.d.ts +51684 -0
- package/types/sap.insights.d.ts +23 -0
- package/types/sap.landvisz.d.ts +7952 -0
- package/types/sap.m.d.ts +147796 -0
- package/types/sap.makit.d.ts +4533 -0
- package/types/sap.me.d.ts +3665 -0
- package/types/sap.ndc.d.ts +774 -0
- package/types/sap.ovp.d.ts +176 -0
- package/types/sap.rules.ui.d.ts +1471 -0
- package/types/sap.sac.df.d.ts +2292 -0
- package/types/sap.sac.grid.d.ts +774 -0
- package/types/sap.suite.ui.commons.d.ts +46971 -0
- package/types/sap.suite.ui.generic.template.d.ts +3431 -0
- package/types/sap.suite.ui.microchart.d.ts +12652 -0
- package/types/sap.tnt.d.ts +2227 -0
- package/types/sap.ui.codeeditor.d.ts +693 -0
- package/types/sap.ui.commons.d.ts +30235 -0
- package/types/sap.ui.comp.d.ts +37411 -0
- package/types/sap.ui.core.d.ts +78872 -0
- package/types/sap.ui.dt.d.ts +3 -0
- package/types/sap.ui.export.d.ts +843 -0
- package/types/sap.ui.fl.d.ts +1663 -0
- package/types/sap.ui.generic.app.d.ts +2683 -0
- package/types/sap.ui.generic.template.d.ts +3 -0
- package/types/sap.ui.integration.d.ts +4032 -0
- package/types/sap.ui.layout.d.ts +14472 -0
- package/types/sap.ui.mdc.d.ts +476 -0
- package/types/sap.ui.richtexteditor.d.ts +1666 -0
- package/types/sap.ui.rta.d.ts +124 -0
- package/types/sap.ui.suite.d.ts +685 -0
- package/types/sap.ui.support.d.ts +453 -0
- package/types/sap.ui.table.d.ts +9325 -0
- package/types/sap.ui.testrecorder.d.ts +9 -0
- package/types/sap.ui.unified.d.ts +20640 -0
- package/types/sap.ui.ux3.d.ts +18288 -0
- package/types/sap.ui.vbm.d.ts +17251 -0
- package/types/sap.ui.vk.d.ts +42381 -0
- package/types/sap.ui.vtm.d.ts +10547 -0
- package/types/sap.ui.webc.common.d.ts +113 -0
- package/types/sap.ui.webc.fiori.d.ts +13850 -0
- package/types/sap.ui.webc.main.d.ts +40833 -0
- package/types/sap.uiext.inbox.d.ts +4079 -0
- package/types/sap.ushell.d.ts +10255 -0
- package/types/sap.ushell_abap.d.ts +9 -0
- package/types/sap.uxap.d.ts +7636 -0
- package/types/sap.viz.d.ts +51209 -0
- package/types/sap.webanalytics.core.d.ts +3 -0
- package/types/sap.zen.commons.d.ts +1542 -0
- package/types/sap.zen.crosstab.d.ts +1159 -0
- package/types/sap.zen.dsh.d.ts +2132 -0
|
@@ -0,0 +1,4533 @@
|
|
|
1
|
+
// For Library Version: 1.113.0
|
|
2
|
+
|
|
3
|
+
declare module "sap/makit/library" {
|
|
4
|
+
/**
|
|
5
|
+
* @SINCE 1.8
|
|
6
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
7
|
+
* will not be supported anymore from 1.38.
|
|
8
|
+
*
|
|
9
|
+
* Enumeration for chart type
|
|
10
|
+
*/
|
|
11
|
+
export enum ChartType {
|
|
12
|
+
/**
|
|
13
|
+
* Horizontal table bar chart
|
|
14
|
+
*/
|
|
15
|
+
Bar = "Bar",
|
|
16
|
+
/**
|
|
17
|
+
* Bubble chart
|
|
18
|
+
*/
|
|
19
|
+
Bubble = "Bubble",
|
|
20
|
+
/**
|
|
21
|
+
* Column chart
|
|
22
|
+
*/
|
|
23
|
+
Column = "Column",
|
|
24
|
+
/**
|
|
25
|
+
* Donut chart
|
|
26
|
+
*/
|
|
27
|
+
Donut = "Donut",
|
|
28
|
+
/**
|
|
29
|
+
* 100% stacked column chart
|
|
30
|
+
*/
|
|
31
|
+
HundredPercentStackedColumn = "HundredPercentStackedColumn",
|
|
32
|
+
/**
|
|
33
|
+
* Line chart
|
|
34
|
+
*/
|
|
35
|
+
Line = "Line",
|
|
36
|
+
/**
|
|
37
|
+
* Pie chart
|
|
38
|
+
*/
|
|
39
|
+
Pie = "Pie",
|
|
40
|
+
/**
|
|
41
|
+
* Stacked column chart
|
|
42
|
+
*/
|
|
43
|
+
StackedColumn = "StackedColumn",
|
|
44
|
+
/**
|
|
45
|
+
* Waterfall Bar chart
|
|
46
|
+
*/
|
|
47
|
+
WaterfallBar = "WaterfallBar",
|
|
48
|
+
/**
|
|
49
|
+
* Waterfall Column chart
|
|
50
|
+
*/
|
|
51
|
+
WaterfallColumn = "WaterfallColumn",
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
55
|
+
* will not be supported anymore from 1.38.
|
|
56
|
+
*
|
|
57
|
+
* Enumeration for legend position.
|
|
58
|
+
*/
|
|
59
|
+
export enum LegendPosition {
|
|
60
|
+
/**
|
|
61
|
+
* Legend location is on the bottom of the chart
|
|
62
|
+
*/
|
|
63
|
+
Bottom = "Bottom",
|
|
64
|
+
/**
|
|
65
|
+
* Legend location is on the left of the chart
|
|
66
|
+
*/
|
|
67
|
+
Left = "Left",
|
|
68
|
+
/**
|
|
69
|
+
* Hide the legend
|
|
70
|
+
*/
|
|
71
|
+
None = "None",
|
|
72
|
+
/**
|
|
73
|
+
* Legend location is on the right of the chart
|
|
74
|
+
*/
|
|
75
|
+
Right = "Right",
|
|
76
|
+
/**
|
|
77
|
+
* Legend location is on the top of the chart
|
|
78
|
+
*/
|
|
79
|
+
Top = "Top",
|
|
80
|
+
}
|
|
81
|
+
/**
|
|
82
|
+
* @SINCE 1.8
|
|
83
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
84
|
+
* will not be supported anymore from 1.38.
|
|
85
|
+
*
|
|
86
|
+
* Enumeration for sort order
|
|
87
|
+
*/
|
|
88
|
+
export enum SortOrder {
|
|
89
|
+
/**
|
|
90
|
+
* Ascending sort
|
|
91
|
+
*/
|
|
92
|
+
Ascending = "Ascending",
|
|
93
|
+
/**
|
|
94
|
+
* Descending sort
|
|
95
|
+
*/
|
|
96
|
+
Descending = "Descending",
|
|
97
|
+
/**
|
|
98
|
+
* No sorting
|
|
99
|
+
*/
|
|
100
|
+
None = "None",
|
|
101
|
+
/**
|
|
102
|
+
* Partially sort
|
|
103
|
+
*/
|
|
104
|
+
Partial = "Partial",
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* @SINCE 1.8
|
|
108
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
109
|
+
* will not be supported anymore from 1.38.
|
|
110
|
+
*
|
|
111
|
+
* Position for Value Bubble only applies to Pie/Donut Chart.
|
|
112
|
+
*/
|
|
113
|
+
export enum ValueBubblePosition {
|
|
114
|
+
/**
|
|
115
|
+
* Value Bubble position set to beside the chart
|
|
116
|
+
*/
|
|
117
|
+
Side = "Side",
|
|
118
|
+
/**
|
|
119
|
+
* Value Bubble position set to above the chart
|
|
120
|
+
*/
|
|
121
|
+
Top = "Top",
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* @SINCE 1.8
|
|
125
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
126
|
+
* will not be supported anymore from 1.38.
|
|
127
|
+
*
|
|
128
|
+
* Enumeration for Value Bubble's positioning style. This applies all chart types except Pie/Donut/HBar
|
|
129
|
+
* chart.
|
|
130
|
+
*/
|
|
131
|
+
export enum ValueBubbleStyle {
|
|
132
|
+
/**
|
|
133
|
+
* The Value Bubble floats on the touch point, chart's size will not change.
|
|
134
|
+
*/
|
|
135
|
+
Float = "Float",
|
|
136
|
+
/**
|
|
137
|
+
* The Value Bubble floats and snaps above of the chart, chart's size will not change.
|
|
138
|
+
*/
|
|
139
|
+
FloatTop = "FloatTop",
|
|
140
|
+
/**
|
|
141
|
+
* The Value Bubble snaps above of the chart, the chart height will adjust accordingly.
|
|
142
|
+
*/
|
|
143
|
+
Top = "Top",
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
declare module "sap/makit/Axis" {
|
|
148
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
149
|
+
|
|
150
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
151
|
+
|
|
152
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* @SINCE 1.8
|
|
156
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
157
|
+
* will not be supported anymore from 1.38.
|
|
158
|
+
*
|
|
159
|
+
* Base element for the Axis object for the Chart.
|
|
160
|
+
*/
|
|
161
|
+
export default class Axis extends UI5Element {
|
|
162
|
+
/**
|
|
163
|
+
* Constructor for a new Axis.
|
|
164
|
+
*
|
|
165
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
166
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
167
|
+
* of the syntax of the settings object.
|
|
168
|
+
*/
|
|
169
|
+
constructor(
|
|
170
|
+
/**
|
|
171
|
+
* initial settings for the new control
|
|
172
|
+
*/
|
|
173
|
+
mSettings?: $AxisSettings
|
|
174
|
+
);
|
|
175
|
+
/**
|
|
176
|
+
* Constructor for a new Axis.
|
|
177
|
+
*
|
|
178
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
179
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
180
|
+
* of the syntax of the settings object.
|
|
181
|
+
*/
|
|
182
|
+
constructor(
|
|
183
|
+
/**
|
|
184
|
+
* id for the new control, generated automatically if no id is given
|
|
185
|
+
*/
|
|
186
|
+
sId?: string,
|
|
187
|
+
/**
|
|
188
|
+
* initial settings for the new control
|
|
189
|
+
*/
|
|
190
|
+
mSettings?: $AxisSettings
|
|
191
|
+
);
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* Creates a new subclass of class sap.makit.Axis with name `sClassName` and enriches it with the information
|
|
195
|
+
* contained in `oClassInfo`.
|
|
196
|
+
*
|
|
197
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
198
|
+
*
|
|
199
|
+
* @returns Created class / constructor function
|
|
200
|
+
*/
|
|
201
|
+
static extend<T extends Record<string, unknown>>(
|
|
202
|
+
/**
|
|
203
|
+
* Name of the class being created
|
|
204
|
+
*/
|
|
205
|
+
sClassName: string,
|
|
206
|
+
/**
|
|
207
|
+
* Object literal with information about the class
|
|
208
|
+
*/
|
|
209
|
+
oClassInfo?: sap.ClassInfo<T, Axis>,
|
|
210
|
+
/**
|
|
211
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
212
|
+
* used by this class
|
|
213
|
+
*/
|
|
214
|
+
FNMetaImpl?: Function
|
|
215
|
+
): Function;
|
|
216
|
+
/**
|
|
217
|
+
* Returns a metadata object for class sap.makit.Axis.
|
|
218
|
+
*
|
|
219
|
+
* @returns Metadata object describing this class
|
|
220
|
+
*/
|
|
221
|
+
static getMetadata(): ElementMetadata;
|
|
222
|
+
/**
|
|
223
|
+
* Gets current value of property {@link #getColor color}.
|
|
224
|
+
*
|
|
225
|
+
* Color of the primary line. Accept the following format: standard name format: gray, red, black, etc hex
|
|
226
|
+
* format: #ff00ff rgb format: rgb(256, 0, 256)
|
|
227
|
+
*
|
|
228
|
+
* Default value is `'gray'`.
|
|
229
|
+
*
|
|
230
|
+
* @returns Value of property `color`
|
|
231
|
+
*/
|
|
232
|
+
getColor(): string;
|
|
233
|
+
/**
|
|
234
|
+
* Gets current value of property {@link #getShowGrid showGrid}.
|
|
235
|
+
*
|
|
236
|
+
* Indicates whether to show grid of the Axis in the chart area
|
|
237
|
+
*
|
|
238
|
+
* Default value is `false`.
|
|
239
|
+
*
|
|
240
|
+
* @returns Value of property `showGrid`
|
|
241
|
+
*/
|
|
242
|
+
getShowGrid(): boolean;
|
|
243
|
+
/**
|
|
244
|
+
* Gets current value of property {@link #getShowLabel showLabel}.
|
|
245
|
+
*
|
|
246
|
+
* Indicates whether to show label of the Axis by the primary line
|
|
247
|
+
*
|
|
248
|
+
* Default value is `true`.
|
|
249
|
+
*
|
|
250
|
+
* @returns Value of property `showLabel`
|
|
251
|
+
*/
|
|
252
|
+
getShowLabel(): boolean;
|
|
253
|
+
/**
|
|
254
|
+
* Gets current value of property {@link #getShowPrimaryLine showPrimaryLine}.
|
|
255
|
+
*
|
|
256
|
+
* Indicates whether to show the primary line of the Axis on the chart area
|
|
257
|
+
*
|
|
258
|
+
* Default value is `true`.
|
|
259
|
+
*
|
|
260
|
+
* @returns Value of property `showPrimaryLine`
|
|
261
|
+
*/
|
|
262
|
+
getShowPrimaryLine(): boolean;
|
|
263
|
+
/**
|
|
264
|
+
* Gets current value of property {@link #getThickness thickness}.
|
|
265
|
+
*
|
|
266
|
+
* The line thickness of the primary line
|
|
267
|
+
*
|
|
268
|
+
* Default value is `1`.
|
|
269
|
+
*
|
|
270
|
+
* @returns Value of property `thickness`
|
|
271
|
+
*/
|
|
272
|
+
getThickness(): float;
|
|
273
|
+
/**
|
|
274
|
+
* Sets a new value for property {@link #getColor color}.
|
|
275
|
+
*
|
|
276
|
+
* Color of the primary line. Accept the following format: standard name format: gray, red, black, etc hex
|
|
277
|
+
* format: #ff00ff rgb format: rgb(256, 0, 256)
|
|
278
|
+
*
|
|
279
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
280
|
+
*
|
|
281
|
+
* Default value is `'gray'`.
|
|
282
|
+
*
|
|
283
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
284
|
+
*/
|
|
285
|
+
setColor(
|
|
286
|
+
/**
|
|
287
|
+
* New value for property `color`
|
|
288
|
+
*/
|
|
289
|
+
sColor?: string
|
|
290
|
+
): this;
|
|
291
|
+
/**
|
|
292
|
+
* Sets a new value for property {@link #getShowGrid showGrid}.
|
|
293
|
+
*
|
|
294
|
+
* Indicates whether to show grid of the Axis in the chart area
|
|
295
|
+
*
|
|
296
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
297
|
+
*
|
|
298
|
+
* Default value is `false`.
|
|
299
|
+
*
|
|
300
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
301
|
+
*/
|
|
302
|
+
setShowGrid(
|
|
303
|
+
/**
|
|
304
|
+
* New value for property `showGrid`
|
|
305
|
+
*/
|
|
306
|
+
bShowGrid?: boolean
|
|
307
|
+
): this;
|
|
308
|
+
/**
|
|
309
|
+
* Sets a new value for property {@link #getShowLabel showLabel}.
|
|
310
|
+
*
|
|
311
|
+
* Indicates whether to show label of the Axis by the primary line
|
|
312
|
+
*
|
|
313
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
314
|
+
*
|
|
315
|
+
* Default value is `true`.
|
|
316
|
+
*
|
|
317
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
318
|
+
*/
|
|
319
|
+
setShowLabel(
|
|
320
|
+
/**
|
|
321
|
+
* New value for property `showLabel`
|
|
322
|
+
*/
|
|
323
|
+
bShowLabel?: boolean
|
|
324
|
+
): this;
|
|
325
|
+
/**
|
|
326
|
+
* Sets a new value for property {@link #getShowPrimaryLine showPrimaryLine}.
|
|
327
|
+
*
|
|
328
|
+
* Indicates whether to show the primary line of the Axis on the chart area
|
|
329
|
+
*
|
|
330
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
331
|
+
*
|
|
332
|
+
* Default value is `true`.
|
|
333
|
+
*
|
|
334
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
335
|
+
*/
|
|
336
|
+
setShowPrimaryLine(
|
|
337
|
+
/**
|
|
338
|
+
* New value for property `showPrimaryLine`
|
|
339
|
+
*/
|
|
340
|
+
bShowPrimaryLine?: boolean
|
|
341
|
+
): this;
|
|
342
|
+
/**
|
|
343
|
+
* Sets a new value for property {@link #getThickness thickness}.
|
|
344
|
+
*
|
|
345
|
+
* The line thickness of the primary line
|
|
346
|
+
*
|
|
347
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
348
|
+
*
|
|
349
|
+
* Default value is `1`.
|
|
350
|
+
*
|
|
351
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
352
|
+
*/
|
|
353
|
+
setThickness(
|
|
354
|
+
/**
|
|
355
|
+
* New value for property `thickness`
|
|
356
|
+
*/
|
|
357
|
+
fThickness?: float
|
|
358
|
+
): this;
|
|
359
|
+
}
|
|
360
|
+
|
|
361
|
+
export interface $AxisSettings extends $ElementSettings {
|
|
362
|
+
/**
|
|
363
|
+
* Indicates whether to show label of the Axis by the primary line
|
|
364
|
+
*/
|
|
365
|
+
showLabel?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
366
|
+
|
|
367
|
+
/**
|
|
368
|
+
* Indicates whether to show the primary line of the Axis on the chart area
|
|
369
|
+
*/
|
|
370
|
+
showPrimaryLine?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
371
|
+
|
|
372
|
+
/**
|
|
373
|
+
* Indicates whether to show grid of the Axis in the chart area
|
|
374
|
+
*/
|
|
375
|
+
showGrid?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
376
|
+
|
|
377
|
+
/**
|
|
378
|
+
* The line thickness of the primary line
|
|
379
|
+
*/
|
|
380
|
+
thickness?: float | PropertyBindingInfo | `{${string}}`;
|
|
381
|
+
|
|
382
|
+
/**
|
|
383
|
+
* Color of the primary line. Accept the following format: standard name format: gray, red, black, etc hex
|
|
384
|
+
* format: #ff00ff rgb format: rgb(256, 0, 256)
|
|
385
|
+
*/
|
|
386
|
+
color?: string | PropertyBindingInfo;
|
|
387
|
+
}
|
|
388
|
+
}
|
|
389
|
+
|
|
390
|
+
declare module "sap/makit/Category" {
|
|
391
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
392
|
+
|
|
393
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
394
|
+
|
|
395
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
396
|
+
|
|
397
|
+
/**
|
|
398
|
+
* @SINCE 1.8
|
|
399
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
400
|
+
* will not be supported anymore from 1.38.
|
|
401
|
+
*
|
|
402
|
+
* Represents the Category data region of the Chart.
|
|
403
|
+
*/
|
|
404
|
+
export default class Category extends UI5Element {
|
|
405
|
+
/**
|
|
406
|
+
* Constructor for a new Category.
|
|
407
|
+
*
|
|
408
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
409
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
410
|
+
* of the syntax of the settings object.
|
|
411
|
+
*/
|
|
412
|
+
constructor(
|
|
413
|
+
/**
|
|
414
|
+
* initial settings for the new control
|
|
415
|
+
*/
|
|
416
|
+
mSettings?: $CategorySettings
|
|
417
|
+
);
|
|
418
|
+
/**
|
|
419
|
+
* Constructor for a new Category.
|
|
420
|
+
*
|
|
421
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
422
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
423
|
+
* of the syntax of the settings object.
|
|
424
|
+
*/
|
|
425
|
+
constructor(
|
|
426
|
+
/**
|
|
427
|
+
* id for the new control, generated automatically if no id is given
|
|
428
|
+
*/
|
|
429
|
+
sId?: string,
|
|
430
|
+
/**
|
|
431
|
+
* initial settings for the new control
|
|
432
|
+
*/
|
|
433
|
+
mSettings?: $CategorySettings
|
|
434
|
+
);
|
|
435
|
+
|
|
436
|
+
/**
|
|
437
|
+
* Creates a new subclass of class sap.makit.Category with name `sClassName` and enriches it with the information
|
|
438
|
+
* contained in `oClassInfo`.
|
|
439
|
+
*
|
|
440
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
441
|
+
*
|
|
442
|
+
* @returns Created class / constructor function
|
|
443
|
+
*/
|
|
444
|
+
static extend<T extends Record<string, unknown>>(
|
|
445
|
+
/**
|
|
446
|
+
* Name of the class being created
|
|
447
|
+
*/
|
|
448
|
+
sClassName: string,
|
|
449
|
+
/**
|
|
450
|
+
* Object literal with information about the class
|
|
451
|
+
*/
|
|
452
|
+
oClassInfo?: sap.ClassInfo<T, Category>,
|
|
453
|
+
/**
|
|
454
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
455
|
+
* used by this class
|
|
456
|
+
*/
|
|
457
|
+
FNMetaImpl?: Function
|
|
458
|
+
): Function;
|
|
459
|
+
/**
|
|
460
|
+
* Returns a metadata object for class sap.makit.Category.
|
|
461
|
+
*
|
|
462
|
+
* @returns Metadata object describing this class
|
|
463
|
+
*/
|
|
464
|
+
static getMetadata(): ElementMetadata;
|
|
465
|
+
/**
|
|
466
|
+
* Gets current value of property {@link #getColumn column}.
|
|
467
|
+
*
|
|
468
|
+
* Specify the name of the column to be mapped to the Category Axis's value.
|
|
469
|
+
*
|
|
470
|
+
* @returns Value of property `column`
|
|
471
|
+
*/
|
|
472
|
+
getColumn(): string;
|
|
473
|
+
/**
|
|
474
|
+
* Gets current value of property {@link #getDisplayName displayName}.
|
|
475
|
+
*
|
|
476
|
+
* The text label representing this Category(on value bubble or table's header)
|
|
477
|
+
*
|
|
478
|
+
* @returns Value of property `displayName`
|
|
479
|
+
*/
|
|
480
|
+
getDisplayName(): string;
|
|
481
|
+
/**
|
|
482
|
+
* Gets current value of property {@link #getFormat format}.
|
|
483
|
+
*
|
|
484
|
+
* Number formatting for the value. Accepted values: number currency percent roundedN - where N represents
|
|
485
|
+
* number of decimal places e.g. rounded4
|
|
486
|
+
*
|
|
487
|
+
* @returns Value of property `format`
|
|
488
|
+
*/
|
|
489
|
+
getFormat(): string;
|
|
490
|
+
/**
|
|
491
|
+
* Sets a new value for property {@link #getColumn column}.
|
|
492
|
+
*
|
|
493
|
+
* Specify the name of the column to be mapped to the Category Axis's value.
|
|
494
|
+
*
|
|
495
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
496
|
+
*
|
|
497
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
498
|
+
*/
|
|
499
|
+
setColumn(
|
|
500
|
+
/**
|
|
501
|
+
* New value for property `column`
|
|
502
|
+
*/
|
|
503
|
+
sColumn?: string
|
|
504
|
+
): this;
|
|
505
|
+
/**
|
|
506
|
+
* Sets a new value for property {@link #getDisplayName displayName}.
|
|
507
|
+
*
|
|
508
|
+
* The text label representing this Category(on value bubble or table's header)
|
|
509
|
+
*
|
|
510
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
511
|
+
*
|
|
512
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
513
|
+
*/
|
|
514
|
+
setDisplayName(
|
|
515
|
+
/**
|
|
516
|
+
* New value for property `displayName`
|
|
517
|
+
*/
|
|
518
|
+
sDisplayName?: string
|
|
519
|
+
): this;
|
|
520
|
+
/**
|
|
521
|
+
* Sets a new value for property {@link #getFormat format}.
|
|
522
|
+
*
|
|
523
|
+
* Number formatting for the value. Accepted values: number currency percent roundedN - where N represents
|
|
524
|
+
* number of decimal places e.g. rounded4
|
|
525
|
+
*
|
|
526
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
527
|
+
*
|
|
528
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
529
|
+
*/
|
|
530
|
+
setFormat(
|
|
531
|
+
/**
|
|
532
|
+
* New value for property `format`
|
|
533
|
+
*/
|
|
534
|
+
sFormat?: string
|
|
535
|
+
): this;
|
|
536
|
+
}
|
|
537
|
+
|
|
538
|
+
export interface $CategorySettings extends $ElementSettings {
|
|
539
|
+
/**
|
|
540
|
+
* Specify the name of the column to be mapped to the Category Axis's value.
|
|
541
|
+
*/
|
|
542
|
+
column?: string | PropertyBindingInfo;
|
|
543
|
+
|
|
544
|
+
/**
|
|
545
|
+
* The text label representing this Category(on value bubble or table's header)
|
|
546
|
+
*/
|
|
547
|
+
displayName?: string | PropertyBindingInfo;
|
|
548
|
+
|
|
549
|
+
/**
|
|
550
|
+
* Number formatting for the value. Accepted values: number currency percent roundedN - where N represents
|
|
551
|
+
* number of decimal places e.g. rounded4
|
|
552
|
+
*/
|
|
553
|
+
format?: string | PropertyBindingInfo;
|
|
554
|
+
}
|
|
555
|
+
}
|
|
556
|
+
|
|
557
|
+
declare module "sap/makit/CategoryAxis" {
|
|
558
|
+
import { default as Axis, $AxisSettings } from "sap/makit/Axis";
|
|
559
|
+
|
|
560
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
561
|
+
|
|
562
|
+
import { SortOrder } from "sap/makit/library";
|
|
563
|
+
|
|
564
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
565
|
+
|
|
566
|
+
/**
|
|
567
|
+
* @SINCE 1.8
|
|
568
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
569
|
+
* will not be supported anymore from 1.38.
|
|
570
|
+
*
|
|
571
|
+
* Contains the properties of the Category's Axis.
|
|
572
|
+
*/
|
|
573
|
+
export default class CategoryAxis extends Axis {
|
|
574
|
+
/**
|
|
575
|
+
* Constructor for a new CategoryAxis.
|
|
576
|
+
*
|
|
577
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
578
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
579
|
+
* of the syntax of the settings object.
|
|
580
|
+
*/
|
|
581
|
+
constructor(
|
|
582
|
+
/**
|
|
583
|
+
* initial settings for the new control
|
|
584
|
+
*/
|
|
585
|
+
mSettings?: $CategoryAxisSettings
|
|
586
|
+
);
|
|
587
|
+
/**
|
|
588
|
+
* Constructor for a new CategoryAxis.
|
|
589
|
+
*
|
|
590
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
591
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
592
|
+
* of the syntax of the settings object.
|
|
593
|
+
*/
|
|
594
|
+
constructor(
|
|
595
|
+
/**
|
|
596
|
+
* id for the new control, generated automatically if no id is given
|
|
597
|
+
*/
|
|
598
|
+
sId?: string,
|
|
599
|
+
/**
|
|
600
|
+
* initial settings for the new control
|
|
601
|
+
*/
|
|
602
|
+
mSettings?: $CategoryAxisSettings
|
|
603
|
+
);
|
|
604
|
+
|
|
605
|
+
/**
|
|
606
|
+
* Creates a new subclass of class sap.makit.CategoryAxis with name `sClassName` and enriches it with the
|
|
607
|
+
* information contained in `oClassInfo`.
|
|
608
|
+
*
|
|
609
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.makit.Axis.extend}.
|
|
610
|
+
*
|
|
611
|
+
* @returns Created class / constructor function
|
|
612
|
+
*/
|
|
613
|
+
static extend<T extends Record<string, unknown>>(
|
|
614
|
+
/**
|
|
615
|
+
* Name of the class being created
|
|
616
|
+
*/
|
|
617
|
+
sClassName: string,
|
|
618
|
+
/**
|
|
619
|
+
* Object literal with information about the class
|
|
620
|
+
*/
|
|
621
|
+
oClassInfo?: sap.ClassInfo<T, CategoryAxis>,
|
|
622
|
+
/**
|
|
623
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
624
|
+
* used by this class
|
|
625
|
+
*/
|
|
626
|
+
FNMetaImpl?: Function
|
|
627
|
+
): Function;
|
|
628
|
+
/**
|
|
629
|
+
* Returns a metadata object for class sap.makit.CategoryAxis.
|
|
630
|
+
*
|
|
631
|
+
* @returns Metadata object describing this class
|
|
632
|
+
*/
|
|
633
|
+
static getMetadata(): ElementMetadata;
|
|
634
|
+
/**
|
|
635
|
+
* Gets current value of property {@link #getDisplayAll displayAll}.
|
|
636
|
+
*
|
|
637
|
+
* Specify whether to display all the category values when there are multiple category data regions.
|
|
638
|
+
*
|
|
639
|
+
* Default value is `true`.
|
|
640
|
+
*
|
|
641
|
+
* @returns Value of property `displayAll`
|
|
642
|
+
*/
|
|
643
|
+
getDisplayAll(): boolean;
|
|
644
|
+
/**
|
|
645
|
+
* Gets current value of property {@link #getDisplayLastLabel displayLastLabel}.
|
|
646
|
+
*
|
|
647
|
+
* Whether to always display the last label on the axis regardless of the automatic resize
|
|
648
|
+
*
|
|
649
|
+
* Default value is `false`.
|
|
650
|
+
*
|
|
651
|
+
* @returns Value of property `displayLastLabel`
|
|
652
|
+
*/
|
|
653
|
+
getDisplayLastLabel(): boolean;
|
|
654
|
+
/**
|
|
655
|
+
* Gets current value of property {@link #getSortOrder sortOrder}.
|
|
656
|
+
*
|
|
657
|
+
* Sort order of the chart
|
|
658
|
+
*
|
|
659
|
+
* Default value is `None`.
|
|
660
|
+
*
|
|
661
|
+
* @returns Value of property `sortOrder`
|
|
662
|
+
*/
|
|
663
|
+
getSortOrder(): SortOrder | keyof typeof SortOrder;
|
|
664
|
+
/**
|
|
665
|
+
* Sets a new value for property {@link #getDisplayAll displayAll}.
|
|
666
|
+
*
|
|
667
|
+
* Specify whether to display all the category values when there are multiple category data regions.
|
|
668
|
+
*
|
|
669
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
670
|
+
*
|
|
671
|
+
* Default value is `true`.
|
|
672
|
+
*
|
|
673
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
674
|
+
*/
|
|
675
|
+
setDisplayAll(
|
|
676
|
+
/**
|
|
677
|
+
* New value for property `displayAll`
|
|
678
|
+
*/
|
|
679
|
+
bDisplayAll?: boolean
|
|
680
|
+
): this;
|
|
681
|
+
/**
|
|
682
|
+
* Sets a new value for property {@link #getDisplayLastLabel displayLastLabel}.
|
|
683
|
+
*
|
|
684
|
+
* Whether to always display the last label on the axis regardless of the automatic resize
|
|
685
|
+
*
|
|
686
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
687
|
+
*
|
|
688
|
+
* Default value is `false`.
|
|
689
|
+
*
|
|
690
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
691
|
+
*/
|
|
692
|
+
setDisplayLastLabel(
|
|
693
|
+
/**
|
|
694
|
+
* New value for property `displayLastLabel`
|
|
695
|
+
*/
|
|
696
|
+
bDisplayLastLabel?: boolean
|
|
697
|
+
): this;
|
|
698
|
+
/**
|
|
699
|
+
* Sets a new value for property {@link #getSortOrder sortOrder}.
|
|
700
|
+
*
|
|
701
|
+
* Sort order of the chart
|
|
702
|
+
*
|
|
703
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
704
|
+
*
|
|
705
|
+
* Default value is `None`.
|
|
706
|
+
*
|
|
707
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
708
|
+
*/
|
|
709
|
+
setSortOrder(
|
|
710
|
+
/**
|
|
711
|
+
* New value for property `sortOrder`
|
|
712
|
+
*/
|
|
713
|
+
sSortOrder?: SortOrder | keyof typeof SortOrder
|
|
714
|
+
): this;
|
|
715
|
+
}
|
|
716
|
+
|
|
717
|
+
export interface $CategoryAxisSettings extends $AxisSettings {
|
|
718
|
+
/**
|
|
719
|
+
* Sort order of the chart
|
|
720
|
+
*/
|
|
721
|
+
sortOrder?:
|
|
722
|
+
| (SortOrder | keyof typeof SortOrder)
|
|
723
|
+
| PropertyBindingInfo
|
|
724
|
+
| `{${string}}`;
|
|
725
|
+
|
|
726
|
+
/**
|
|
727
|
+
* Whether to always display the last label on the axis regardless of the automatic resize
|
|
728
|
+
*/
|
|
729
|
+
displayLastLabel?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
730
|
+
|
|
731
|
+
/**
|
|
732
|
+
* Specify whether to display all the category values when there are multiple category data regions.
|
|
733
|
+
*/
|
|
734
|
+
displayAll?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
735
|
+
}
|
|
736
|
+
}
|
|
737
|
+
|
|
738
|
+
declare module "sap/makit/Chart" {
|
|
739
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
740
|
+
|
|
741
|
+
import Column from "sap/makit/Column";
|
|
742
|
+
|
|
743
|
+
import Event from "sap/ui/base/Event";
|
|
744
|
+
|
|
745
|
+
import {
|
|
746
|
+
AggregationBindingInfo,
|
|
747
|
+
PropertyBindingInfo,
|
|
748
|
+
} from "sap/ui/base/ManagedObject";
|
|
749
|
+
|
|
750
|
+
import CategoryAxis from "sap/makit/CategoryAxis";
|
|
751
|
+
|
|
752
|
+
import Category from "sap/makit/Category";
|
|
753
|
+
|
|
754
|
+
import { CSSSize } from "sap/ui/core/library";
|
|
755
|
+
|
|
756
|
+
import { LegendPosition, ChartType } from "sap/makit/library";
|
|
757
|
+
|
|
758
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
759
|
+
|
|
760
|
+
import Row from "sap/makit/Row";
|
|
761
|
+
|
|
762
|
+
import Series from "sap/makit/Series";
|
|
763
|
+
|
|
764
|
+
import ValueAxis from "sap/makit/ValueAxis";
|
|
765
|
+
|
|
766
|
+
import ValueBubble from "sap/makit/ValueBubble";
|
|
767
|
+
|
|
768
|
+
import Value from "sap/makit/Value";
|
|
769
|
+
|
|
770
|
+
/**
|
|
771
|
+
* @SINCE 1.8
|
|
772
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and VizFrame in 1.38. This control
|
|
773
|
+
* will not be supported anymore from 1.38.
|
|
774
|
+
*
|
|
775
|
+
* The Chart control.
|
|
776
|
+
*/
|
|
777
|
+
export default class Chart extends Control {
|
|
778
|
+
/**
|
|
779
|
+
* Constructor for a new Chart.
|
|
780
|
+
*
|
|
781
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
782
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
783
|
+
* of the syntax of the settings object.
|
|
784
|
+
*/
|
|
785
|
+
constructor(
|
|
786
|
+
/**
|
|
787
|
+
* initial settings for the new control
|
|
788
|
+
*/
|
|
789
|
+
mSettings?: $ChartSettings
|
|
790
|
+
);
|
|
791
|
+
/**
|
|
792
|
+
* Constructor for a new Chart.
|
|
793
|
+
*
|
|
794
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
795
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
796
|
+
* of the syntax of the settings object.
|
|
797
|
+
*/
|
|
798
|
+
constructor(
|
|
799
|
+
/**
|
|
800
|
+
* id for the new control, generated automatically if no id is given
|
|
801
|
+
*/
|
|
802
|
+
sId?: string,
|
|
803
|
+
/**
|
|
804
|
+
* initial settings for the new control
|
|
805
|
+
*/
|
|
806
|
+
mSettings?: $ChartSettings
|
|
807
|
+
);
|
|
808
|
+
|
|
809
|
+
/**
|
|
810
|
+
* Creates a new subclass of class sap.makit.Chart with name `sClassName` and enriches it with the information
|
|
811
|
+
* contained in `oClassInfo`.
|
|
812
|
+
*
|
|
813
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
814
|
+
*
|
|
815
|
+
* @returns Created class / constructor function
|
|
816
|
+
*/
|
|
817
|
+
static extend<T extends Record<string, unknown>>(
|
|
818
|
+
/**
|
|
819
|
+
* Name of the class being created
|
|
820
|
+
*/
|
|
821
|
+
sClassName: string,
|
|
822
|
+
/**
|
|
823
|
+
* Object literal with information about the class
|
|
824
|
+
*/
|
|
825
|
+
oClassInfo?: sap.ClassInfo<T, Chart>,
|
|
826
|
+
/**
|
|
827
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
828
|
+
* used by this class
|
|
829
|
+
*/
|
|
830
|
+
FNMetaImpl?: Function
|
|
831
|
+
): Function;
|
|
832
|
+
/**
|
|
833
|
+
* Returns a metadata object for class sap.makit.Chart.
|
|
834
|
+
*
|
|
835
|
+
* @returns Metadata object describing this class
|
|
836
|
+
*/
|
|
837
|
+
static getMetadata(): ElementMetadata;
|
|
838
|
+
/**
|
|
839
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
840
|
+
* will not be supported anymore from 1.38.
|
|
841
|
+
*
|
|
842
|
+
* Adds some column to the aggregation {@link #getColumns columns}.
|
|
843
|
+
*
|
|
844
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
845
|
+
*/
|
|
846
|
+
addColumn(
|
|
847
|
+
/**
|
|
848
|
+
* The column to add; if empty, nothing is inserted
|
|
849
|
+
*/
|
|
850
|
+
oColumn: Column
|
|
851
|
+
): this;
|
|
852
|
+
/**
|
|
853
|
+
* Attaches event handler `fnFunction` to the {@link #event:doubletap doubletap} event of this `sap.makit.Chart`.
|
|
854
|
+
*
|
|
855
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
856
|
+
* otherwise it will be bound to this `sap.makit.Chart` itself.
|
|
857
|
+
*
|
|
858
|
+
* Double tap event on the chart
|
|
859
|
+
*
|
|
860
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
861
|
+
*/
|
|
862
|
+
attachDoubletap(
|
|
863
|
+
/**
|
|
864
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
865
|
+
* object when firing the event
|
|
866
|
+
*/
|
|
867
|
+
oData: object,
|
|
868
|
+
/**
|
|
869
|
+
* The function to be called when the event occurs
|
|
870
|
+
*/
|
|
871
|
+
fnFunction: (p1: Event) => void,
|
|
872
|
+
/**
|
|
873
|
+
* Context object to call the event handler with. Defaults to this `sap.makit.Chart` itself
|
|
874
|
+
*/
|
|
875
|
+
oListener?: object
|
|
876
|
+
): this;
|
|
877
|
+
/**
|
|
878
|
+
* Attaches event handler `fnFunction` to the {@link #event:doubletap doubletap} event of this `sap.makit.Chart`.
|
|
879
|
+
*
|
|
880
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
881
|
+
* otherwise it will be bound to this `sap.makit.Chart` itself.
|
|
882
|
+
*
|
|
883
|
+
* Double tap event on the chart
|
|
884
|
+
*
|
|
885
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
886
|
+
*/
|
|
887
|
+
attachDoubletap(
|
|
888
|
+
/**
|
|
889
|
+
* The function to be called when the event occurs
|
|
890
|
+
*/
|
|
891
|
+
fnFunction: (p1: Event) => void,
|
|
892
|
+
/**
|
|
893
|
+
* Context object to call the event handler with. Defaults to this `sap.makit.Chart` itself
|
|
894
|
+
*/
|
|
895
|
+
oListener?: object
|
|
896
|
+
): this;
|
|
897
|
+
/**
|
|
898
|
+
* Attaches event handler `fnFunction` to the {@link #event:longpress longpress} event of this `sap.makit.Chart`.
|
|
899
|
+
*
|
|
900
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
901
|
+
* otherwise it will be bound to this `sap.makit.Chart` itself.
|
|
902
|
+
*
|
|
903
|
+
* Long press event on the chart
|
|
904
|
+
*
|
|
905
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
906
|
+
*/
|
|
907
|
+
attachLongpress(
|
|
908
|
+
/**
|
|
909
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
910
|
+
* object when firing the event
|
|
911
|
+
*/
|
|
912
|
+
oData: object,
|
|
913
|
+
/**
|
|
914
|
+
* The function to be called when the event occurs
|
|
915
|
+
*/
|
|
916
|
+
fnFunction: (p1: Event) => void,
|
|
917
|
+
/**
|
|
918
|
+
* Context object to call the event handler with. Defaults to this `sap.makit.Chart` itself
|
|
919
|
+
*/
|
|
920
|
+
oListener?: object
|
|
921
|
+
): this;
|
|
922
|
+
/**
|
|
923
|
+
* Attaches event handler `fnFunction` to the {@link #event:longpress longpress} event of this `sap.makit.Chart`.
|
|
924
|
+
*
|
|
925
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
926
|
+
* otherwise it will be bound to this `sap.makit.Chart` itself.
|
|
927
|
+
*
|
|
928
|
+
* Long press event on the chart
|
|
929
|
+
*
|
|
930
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
931
|
+
*/
|
|
932
|
+
attachLongpress(
|
|
933
|
+
/**
|
|
934
|
+
* The function to be called when the event occurs
|
|
935
|
+
*/
|
|
936
|
+
fnFunction: (p1: Event) => void,
|
|
937
|
+
/**
|
|
938
|
+
* Context object to call the event handler with. Defaults to this `sap.makit.Chart` itself
|
|
939
|
+
*/
|
|
940
|
+
oListener?: object
|
|
941
|
+
): this;
|
|
942
|
+
/**
|
|
943
|
+
* Attaches event handler `fnFunction` to the {@link #event:tap tap} event of this `sap.makit.Chart`.
|
|
944
|
+
*
|
|
945
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
946
|
+
* otherwise it will be bound to this `sap.makit.Chart` itself.
|
|
947
|
+
*
|
|
948
|
+
* Single tap event on the chart
|
|
949
|
+
*
|
|
950
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
951
|
+
*/
|
|
952
|
+
attachTap(
|
|
953
|
+
/**
|
|
954
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
955
|
+
* object when firing the event
|
|
956
|
+
*/
|
|
957
|
+
oData: object,
|
|
958
|
+
/**
|
|
959
|
+
* The function to be called when the event occurs
|
|
960
|
+
*/
|
|
961
|
+
fnFunction: (p1: Event) => void,
|
|
962
|
+
/**
|
|
963
|
+
* Context object to call the event handler with. Defaults to this `sap.makit.Chart` itself
|
|
964
|
+
*/
|
|
965
|
+
oListener?: object
|
|
966
|
+
): this;
|
|
967
|
+
/**
|
|
968
|
+
* Attaches event handler `fnFunction` to the {@link #event:tap tap} event of this `sap.makit.Chart`.
|
|
969
|
+
*
|
|
970
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
971
|
+
* otherwise it will be bound to this `sap.makit.Chart` itself.
|
|
972
|
+
*
|
|
973
|
+
* Single tap event on the chart
|
|
974
|
+
*
|
|
975
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
976
|
+
*/
|
|
977
|
+
attachTap(
|
|
978
|
+
/**
|
|
979
|
+
* The function to be called when the event occurs
|
|
980
|
+
*/
|
|
981
|
+
fnFunction: (p1: Event) => void,
|
|
982
|
+
/**
|
|
983
|
+
* Context object to call the event handler with. Defaults to this `sap.makit.Chart` itself
|
|
984
|
+
*/
|
|
985
|
+
oListener?: object
|
|
986
|
+
): this;
|
|
987
|
+
/**
|
|
988
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
989
|
+
* will not be supported anymore from 1.38.
|
|
990
|
+
*
|
|
991
|
+
* Binds aggregation {@link #getColumns columns} to model data.
|
|
992
|
+
*
|
|
993
|
+
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
|
|
994
|
+
* of the possible properties of `oBindingInfo`.
|
|
995
|
+
*
|
|
996
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
997
|
+
*/
|
|
998
|
+
bindColumns(
|
|
999
|
+
/**
|
|
1000
|
+
* The binding information
|
|
1001
|
+
*/
|
|
1002
|
+
oBindingInfo: AggregationBindingInfo
|
|
1003
|
+
): this;
|
|
1004
|
+
/**
|
|
1005
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1006
|
+
* will not be supported anymore from 1.38.
|
|
1007
|
+
*
|
|
1008
|
+
* Binds aggregation {@link #getRows rows} to model data.
|
|
1009
|
+
*
|
|
1010
|
+
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
|
|
1011
|
+
* of the possible properties of `oBindingInfo`.
|
|
1012
|
+
*
|
|
1013
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1014
|
+
*/
|
|
1015
|
+
bindRows(
|
|
1016
|
+
/**
|
|
1017
|
+
* The binding information
|
|
1018
|
+
*/
|
|
1019
|
+
oBindingInfo: AggregationBindingInfo
|
|
1020
|
+
): this;
|
|
1021
|
+
/**
|
|
1022
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1023
|
+
* will not be supported anymore from 1.38.
|
|
1024
|
+
*
|
|
1025
|
+
* Destroys the categoryAxis in the aggregation {@link #getCategoryAxis categoryAxis}.
|
|
1026
|
+
*
|
|
1027
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1028
|
+
*/
|
|
1029
|
+
destroyCategoryAxis(): this;
|
|
1030
|
+
/**
|
|
1031
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1032
|
+
* will not be supported anymore from 1.38.
|
|
1033
|
+
*
|
|
1034
|
+
* Destroys all the categoryRegions in the aggregation {@link #getCategoryRegions categoryRegions}.
|
|
1035
|
+
*
|
|
1036
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1037
|
+
*/
|
|
1038
|
+
destroyCategoryRegions(): this;
|
|
1039
|
+
/**
|
|
1040
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1041
|
+
* will not be supported anymore from 1.38.
|
|
1042
|
+
*
|
|
1043
|
+
* Destroys all the columns in the aggregation {@link #getColumns columns}.
|
|
1044
|
+
*
|
|
1045
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1046
|
+
*/
|
|
1047
|
+
destroyColumns(): this;
|
|
1048
|
+
/**
|
|
1049
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1050
|
+
* will not be supported anymore from 1.38.
|
|
1051
|
+
*
|
|
1052
|
+
* Destroys the series in the aggregation {@link #getSeries series}.
|
|
1053
|
+
*
|
|
1054
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1055
|
+
*/
|
|
1056
|
+
destroySeries(): this;
|
|
1057
|
+
/**
|
|
1058
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1059
|
+
* will not be supported anymore from 1.38.
|
|
1060
|
+
*
|
|
1061
|
+
* Destroys the valueAxis in the aggregation {@link #getValueAxis valueAxis}.
|
|
1062
|
+
*
|
|
1063
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1064
|
+
*/
|
|
1065
|
+
destroyValueAxis(): this;
|
|
1066
|
+
/**
|
|
1067
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1068
|
+
* will not be supported anymore from 1.38.
|
|
1069
|
+
*
|
|
1070
|
+
* Destroys the valueBubble in the aggregation {@link #getValueBubble valueBubble}.
|
|
1071
|
+
*
|
|
1072
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1073
|
+
*/
|
|
1074
|
+
destroyValueBubble(): this;
|
|
1075
|
+
/**
|
|
1076
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1077
|
+
* will not be supported anymore from 1.38.
|
|
1078
|
+
*
|
|
1079
|
+
* Destroys all the values in the aggregation {@link #getValues values}.
|
|
1080
|
+
*
|
|
1081
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1082
|
+
*/
|
|
1083
|
+
destroyValues(): this;
|
|
1084
|
+
/**
|
|
1085
|
+
* Detaches event handler `fnFunction` from the {@link #event:doubletap doubletap} event of this `sap.makit.Chart`.
|
|
1086
|
+
*
|
|
1087
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
1088
|
+
*
|
|
1089
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1090
|
+
*/
|
|
1091
|
+
detachDoubletap(
|
|
1092
|
+
/**
|
|
1093
|
+
* The function to be called, when the event occurs
|
|
1094
|
+
*/
|
|
1095
|
+
fnFunction: (p1: Event) => void,
|
|
1096
|
+
/**
|
|
1097
|
+
* Context object on which the given function had to be called
|
|
1098
|
+
*/
|
|
1099
|
+
oListener?: object
|
|
1100
|
+
): this;
|
|
1101
|
+
/**
|
|
1102
|
+
* Detaches event handler `fnFunction` from the {@link #event:longpress longpress} event of this `sap.makit.Chart`.
|
|
1103
|
+
*
|
|
1104
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
1105
|
+
*
|
|
1106
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1107
|
+
*/
|
|
1108
|
+
detachLongpress(
|
|
1109
|
+
/**
|
|
1110
|
+
* The function to be called, when the event occurs
|
|
1111
|
+
*/
|
|
1112
|
+
fnFunction: (p1: Event) => void,
|
|
1113
|
+
/**
|
|
1114
|
+
* Context object on which the given function had to be called
|
|
1115
|
+
*/
|
|
1116
|
+
oListener?: object
|
|
1117
|
+
): this;
|
|
1118
|
+
/**
|
|
1119
|
+
* Detaches event handler `fnFunction` from the {@link #event:tap tap} event of this `sap.makit.Chart`.
|
|
1120
|
+
*
|
|
1121
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
1122
|
+
*
|
|
1123
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1124
|
+
*/
|
|
1125
|
+
detachTap(
|
|
1126
|
+
/**
|
|
1127
|
+
* The function to be called, when the event occurs
|
|
1128
|
+
*/
|
|
1129
|
+
fnFunction: (p1: Event) => void,
|
|
1130
|
+
/**
|
|
1131
|
+
* Context object on which the given function had to be called
|
|
1132
|
+
*/
|
|
1133
|
+
oListener?: object
|
|
1134
|
+
): this;
|
|
1135
|
+
/**
|
|
1136
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1137
|
+
*
|
|
1138
|
+
* Fires event {@link #event:doubletap doubletap} to attached listeners.
|
|
1139
|
+
*
|
|
1140
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1141
|
+
*/
|
|
1142
|
+
fireDoubletap(
|
|
1143
|
+
/**
|
|
1144
|
+
* Parameters to pass along with the event
|
|
1145
|
+
*/
|
|
1146
|
+
mParameters?: object
|
|
1147
|
+
): this;
|
|
1148
|
+
/**
|
|
1149
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1150
|
+
*
|
|
1151
|
+
* Fires event {@link #event:longpress longpress} to attached listeners.
|
|
1152
|
+
*
|
|
1153
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1154
|
+
*/
|
|
1155
|
+
fireLongpress(
|
|
1156
|
+
/**
|
|
1157
|
+
* Parameters to pass along with the event
|
|
1158
|
+
*/
|
|
1159
|
+
mParameters?: object
|
|
1160
|
+
): this;
|
|
1161
|
+
/**
|
|
1162
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1163
|
+
*
|
|
1164
|
+
* Fires event {@link #event:tap tap} to attached listeners.
|
|
1165
|
+
*
|
|
1166
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1167
|
+
*/
|
|
1168
|
+
fireTap(
|
|
1169
|
+
/**
|
|
1170
|
+
* Parameters to pass along with the event
|
|
1171
|
+
*/
|
|
1172
|
+
mParameters?: object
|
|
1173
|
+
): this;
|
|
1174
|
+
/**
|
|
1175
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1176
|
+
* will not be supported anymore from 1.38.
|
|
1177
|
+
*
|
|
1178
|
+
* Gets content of aggregation {@link #getCategoryAxis categoryAxis}.
|
|
1179
|
+
*
|
|
1180
|
+
* Category Axis property of the Chart. Accepts only an instance of CategoryAxis element.
|
|
1181
|
+
*/
|
|
1182
|
+
getCategoryAxis(): CategoryAxis;
|
|
1183
|
+
/**
|
|
1184
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1185
|
+
* will not be supported anymore from 1.38.
|
|
1186
|
+
*
|
|
1187
|
+
* Gets content of aggregation {@link #getCategoryRegions categoryRegions}.
|
|
1188
|
+
*
|
|
1189
|
+
* Data region property of the chart's Categories
|
|
1190
|
+
*/
|
|
1191
|
+
getCategoryRegions(): Category[];
|
|
1192
|
+
/**
|
|
1193
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1194
|
+
* will not be supported anymore from 1.38.
|
|
1195
|
+
*
|
|
1196
|
+
* Gets content of aggregation {@link #getColumns columns}.
|
|
1197
|
+
*
|
|
1198
|
+
* The data column map of the chart.
|
|
1199
|
+
*/
|
|
1200
|
+
getColumns(): Column[];
|
|
1201
|
+
/**
|
|
1202
|
+
* Gets current value of property {@link #getHeight height}.
|
|
1203
|
+
*
|
|
1204
|
+
* The height of the Chart
|
|
1205
|
+
*
|
|
1206
|
+
* Default value is `'100%'`.
|
|
1207
|
+
*
|
|
1208
|
+
* @returns Value of property `height`
|
|
1209
|
+
*/
|
|
1210
|
+
getHeight(): CSSSize;
|
|
1211
|
+
/**
|
|
1212
|
+
* Gets current value of property {@link #getLegendPosition legendPosition}.
|
|
1213
|
+
*
|
|
1214
|
+
* Legend position all chart types except Bar chart. Default position for Pie/Donut chart is Left. All other
|
|
1215
|
+
* chart's default position is None. Note: the default legend position is set when the chart type is set
|
|
1216
|
+
* first time, subsequent change to the chart type will keep using initial legend position unless it is
|
|
1217
|
+
* changed explicitly by user.
|
|
1218
|
+
*
|
|
1219
|
+
* @returns Value of property `legendPosition`
|
|
1220
|
+
*/
|
|
1221
|
+
getLegendPosition(): LegendPosition | keyof typeof LegendPosition;
|
|
1222
|
+
/**
|
|
1223
|
+
* Gets current value of property {@link #getLineThickness lineThickness}.
|
|
1224
|
+
*
|
|
1225
|
+
* Specify the line thickness of the line graph. Only applies to Line chart type.
|
|
1226
|
+
*
|
|
1227
|
+
* Default value is `1`.
|
|
1228
|
+
*
|
|
1229
|
+
* @returns Value of property `lineThickness`
|
|
1230
|
+
*/
|
|
1231
|
+
getLineThickness(): float;
|
|
1232
|
+
/**
|
|
1233
|
+
* Gets current value of property {@link #getMaxSliceCount maxSliceCount}.
|
|
1234
|
+
*
|
|
1235
|
+
* Set the maximum number of slices in a Pie/Donut chart. If exceeding the specified value, the rest will
|
|
1236
|
+
* be categorised into a single slice. Only applies to Pie/Donut.
|
|
1237
|
+
*
|
|
1238
|
+
* Default value is `12`.
|
|
1239
|
+
*
|
|
1240
|
+
* @returns Value of property `maxSliceCount`
|
|
1241
|
+
*/
|
|
1242
|
+
getMaxSliceCount(): int;
|
|
1243
|
+
/**
|
|
1244
|
+
* Get the number of distinct category values
|
|
1245
|
+
*/
|
|
1246
|
+
getNumberOfCategories(): int;
|
|
1247
|
+
/**
|
|
1248
|
+
* Gets current value of property {@link #getNumberOfVisibleCategories numberOfVisibleCategories}.
|
|
1249
|
+
*
|
|
1250
|
+
* The number of categories that will be visible on the chart at any time. The minimum value is 2. If not
|
|
1251
|
+
* set, the number of visible categories will be automatically adjusted depending on the screen size
|
|
1252
|
+
*
|
|
1253
|
+
* @returns Value of property `numberOfVisibleCategories`
|
|
1254
|
+
*/
|
|
1255
|
+
getNumberOfVisibleCategories(): int;
|
|
1256
|
+
/**
|
|
1257
|
+
* Gets current value of property {@link #getPrimaryColorPalette primaryColorPalette}.
|
|
1258
|
+
*
|
|
1259
|
+
* Allow a chart’s color palette to be modified without affecting the other charts' color palette. If not
|
|
1260
|
+
* set, the chart will use the default color palette defined in the theme. Accept an array of color in string
|
|
1261
|
+
* format or hex format. e.g. 0xff0000 "red" "rgb(255,0,0)"
|
|
1262
|
+
*
|
|
1263
|
+
* @returns Value of property `primaryColorPalette`
|
|
1264
|
+
*/
|
|
1265
|
+
getPrimaryColorPalette(): any;
|
|
1266
|
+
/**
|
|
1267
|
+
* Gets current value of property {@link #getRangeSelectorStartPosition rangeSelectorStartPosition}.
|
|
1268
|
+
*
|
|
1269
|
+
* Specify the range selector start position, default value is 0.
|
|
1270
|
+
*
|
|
1271
|
+
* Default value is `0`.
|
|
1272
|
+
*
|
|
1273
|
+
* @returns Value of property `rangeSelectorStartPosition`
|
|
1274
|
+
*/
|
|
1275
|
+
getRangeSelectorStartPosition(): int;
|
|
1276
|
+
/**
|
|
1277
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1278
|
+
* will not be supported anymore from 1.38.
|
|
1279
|
+
*
|
|
1280
|
+
* Gets content of aggregation {@link #getRows rows}.
|
|
1281
|
+
*
|
|
1282
|
+
* The data rows of the chart. User should bind these to their data source
|
|
1283
|
+
*/
|
|
1284
|
+
getRows(): Row[];
|
|
1285
|
+
/**
|
|
1286
|
+
* Get the value of the currently highlighted category
|
|
1287
|
+
*/
|
|
1288
|
+
getSelectedCategory(): string;
|
|
1289
|
+
/**
|
|
1290
|
+
* Return an array of categories value that is currently selected.
|
|
1291
|
+
*/
|
|
1292
|
+
getSelectedCategoryGroup(): object;
|
|
1293
|
+
/**
|
|
1294
|
+
* Get the value of the currently highlighted series
|
|
1295
|
+
*/
|
|
1296
|
+
getSelectedSeries(): string;
|
|
1297
|
+
/**
|
|
1298
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1299
|
+
* will not be supported anymore from 1.38.
|
|
1300
|
+
*
|
|
1301
|
+
* Gets content of aggregation {@link #getSeries series}.
|
|
1302
|
+
*
|
|
1303
|
+
* Data region property of the chart's Series
|
|
1304
|
+
*/
|
|
1305
|
+
getSeries(): Series;
|
|
1306
|
+
/**
|
|
1307
|
+
* Gets current value of property {@link #getShowRangeSelector showRangeSelector}.
|
|
1308
|
+
*
|
|
1309
|
+
* Specify whether the range selector should be visible.
|
|
1310
|
+
*
|
|
1311
|
+
* Default value is `true`.
|
|
1312
|
+
*
|
|
1313
|
+
* @returns Value of property `showRangeSelector`
|
|
1314
|
+
*/
|
|
1315
|
+
getShowRangeSelector(): boolean;
|
|
1316
|
+
/**
|
|
1317
|
+
* Gets current value of property {@link #getShowTableValue showTableValue}.
|
|
1318
|
+
*
|
|
1319
|
+
* Toggle to display the table value on a Bar chart. Only applies to Bar chart.
|
|
1320
|
+
*
|
|
1321
|
+
* Default value is `true`.
|
|
1322
|
+
*
|
|
1323
|
+
* @returns Value of property `showTableValue`
|
|
1324
|
+
*/
|
|
1325
|
+
getShowTableValue(): boolean;
|
|
1326
|
+
/**
|
|
1327
|
+
* Gets current value of property {@link #getShowTableView showTableView}.
|
|
1328
|
+
*
|
|
1329
|
+
* Toggle to display table view
|
|
1330
|
+
*
|
|
1331
|
+
* Default value is `false`.
|
|
1332
|
+
*
|
|
1333
|
+
* @returns Value of property `showTableView`
|
|
1334
|
+
*/
|
|
1335
|
+
getShowTableView(): boolean;
|
|
1336
|
+
/**
|
|
1337
|
+
* Gets current value of property {@link #getShowTotalValue showTotalValue}.
|
|
1338
|
+
*
|
|
1339
|
+
* Specify whether to show the sum of the value for Waterfall/Waterfall Bar chart. Only applies to Waterfall/WaterfallBar
|
|
1340
|
+
* chart.
|
|
1341
|
+
*
|
|
1342
|
+
* Default value is `false`.
|
|
1343
|
+
*
|
|
1344
|
+
* @returns Value of property `showTotalValue`
|
|
1345
|
+
*/
|
|
1346
|
+
getShowTotalValue(): boolean;
|
|
1347
|
+
/**
|
|
1348
|
+
* Gets current value of property {@link #getType type}.
|
|
1349
|
+
*
|
|
1350
|
+
* Chart type
|
|
1351
|
+
*
|
|
1352
|
+
* Default value is `Column`.
|
|
1353
|
+
*
|
|
1354
|
+
* @returns Value of property `type`
|
|
1355
|
+
*/
|
|
1356
|
+
getType(): ChartType | keyof typeof ChartType;
|
|
1357
|
+
/**
|
|
1358
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1359
|
+
* will not be supported anymore from 1.38.
|
|
1360
|
+
*
|
|
1361
|
+
* Gets content of aggregation {@link #getValueAxis valueAxis}.
|
|
1362
|
+
*
|
|
1363
|
+
* Value Axis property of the Chart. Accept only an instance of ValueAxis element.
|
|
1364
|
+
*/
|
|
1365
|
+
getValueAxis(): ValueAxis;
|
|
1366
|
+
/**
|
|
1367
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1368
|
+
* will not be supported anymore from 1.38.
|
|
1369
|
+
*
|
|
1370
|
+
* Gets content of aggregation {@link #getValueBubble valueBubble}.
|
|
1371
|
+
*
|
|
1372
|
+
* Value Bubble property of the Chart. Accept only an instance of ValueBubble element.
|
|
1373
|
+
*/
|
|
1374
|
+
getValueBubble(): ValueBubble;
|
|
1375
|
+
/**
|
|
1376
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1377
|
+
* will not be supported anymore from 1.38.
|
|
1378
|
+
*
|
|
1379
|
+
* Gets content of aggregation {@link #getValues values}.
|
|
1380
|
+
*
|
|
1381
|
+
* Data region property of the chart's Values
|
|
1382
|
+
*/
|
|
1383
|
+
getValues(): Value[];
|
|
1384
|
+
/**
|
|
1385
|
+
* Gets current value of property {@link #getWidth width}.
|
|
1386
|
+
*
|
|
1387
|
+
* The width of the Chart
|
|
1388
|
+
*
|
|
1389
|
+
* Default value is `'100%'`.
|
|
1390
|
+
*
|
|
1391
|
+
* @returns Value of property `width`
|
|
1392
|
+
*/
|
|
1393
|
+
getWidth(): CSSSize;
|
|
1394
|
+
/**
|
|
1395
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1396
|
+
* will not be supported anymore from 1.38.
|
|
1397
|
+
*
|
|
1398
|
+
* Checks for the provided `sap.makit.Category` in the aggregation {@link #getCategoryRegions categoryRegions}.
|
|
1399
|
+
* and returns its index if found or -1 otherwise.
|
|
1400
|
+
*
|
|
1401
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
1402
|
+
*/
|
|
1403
|
+
indexOfCategoryRegion(
|
|
1404
|
+
/**
|
|
1405
|
+
* The categoryRegion whose index is looked for
|
|
1406
|
+
*/
|
|
1407
|
+
oCategoryRegion: Category
|
|
1408
|
+
): int;
|
|
1409
|
+
/**
|
|
1410
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1411
|
+
* will not be supported anymore from 1.38.
|
|
1412
|
+
*
|
|
1413
|
+
* Checks for the provided `sap.makit.Column` in the aggregation {@link #getColumns columns}. and returns
|
|
1414
|
+
* its index if found or -1 otherwise.
|
|
1415
|
+
*
|
|
1416
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
1417
|
+
*/
|
|
1418
|
+
indexOfColumn(
|
|
1419
|
+
/**
|
|
1420
|
+
* The column whose index is looked for
|
|
1421
|
+
*/
|
|
1422
|
+
oColumn: Column
|
|
1423
|
+
): int;
|
|
1424
|
+
/**
|
|
1425
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1426
|
+
* will not be supported anymore from 1.38.
|
|
1427
|
+
*
|
|
1428
|
+
* Checks for the provided `sap.makit.Row` in the aggregation {@link #getRows rows}. and returns its index
|
|
1429
|
+
* if found or -1 otherwise.
|
|
1430
|
+
*
|
|
1431
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
1432
|
+
*/
|
|
1433
|
+
indexOfRow(
|
|
1434
|
+
/**
|
|
1435
|
+
* The row whose index is looked for
|
|
1436
|
+
*/
|
|
1437
|
+
oRow: Row
|
|
1438
|
+
): int;
|
|
1439
|
+
/**
|
|
1440
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1441
|
+
* will not be supported anymore from 1.38.
|
|
1442
|
+
*
|
|
1443
|
+
* Checks for the provided `sap.makit.Value` in the aggregation {@link #getValues values}. and returns its
|
|
1444
|
+
* index if found or -1 otherwise.
|
|
1445
|
+
*
|
|
1446
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
1447
|
+
*/
|
|
1448
|
+
indexOfValue(
|
|
1449
|
+
/**
|
|
1450
|
+
* The value whose index is looked for
|
|
1451
|
+
*/
|
|
1452
|
+
oValue: Value
|
|
1453
|
+
): int;
|
|
1454
|
+
/**
|
|
1455
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1456
|
+
* will not be supported anymore from 1.38.
|
|
1457
|
+
*
|
|
1458
|
+
* Inserts a column into the aggregation {@link #getColumns columns}.
|
|
1459
|
+
*
|
|
1460
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1461
|
+
*/
|
|
1462
|
+
insertColumn(
|
|
1463
|
+
/**
|
|
1464
|
+
* The column to insert; if empty, nothing is inserted
|
|
1465
|
+
*/
|
|
1466
|
+
oColumn: Column,
|
|
1467
|
+
/**
|
|
1468
|
+
* The `0`-based index the column should be inserted at; for a negative value of `iIndex`, the column is
|
|
1469
|
+
* inserted at position 0; for a value greater than the current size of the aggregation, the column is inserted
|
|
1470
|
+
* at the last position
|
|
1471
|
+
*/
|
|
1472
|
+
iIndex: int
|
|
1473
|
+
): this;
|
|
1474
|
+
/**
|
|
1475
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1476
|
+
* will not be supported anymore from 1.38.
|
|
1477
|
+
*
|
|
1478
|
+
* Removes all the controls from the aggregation {@link #getColumns columns}.
|
|
1479
|
+
*
|
|
1480
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
1481
|
+
*
|
|
1482
|
+
* @returns An array of the removed elements (might be empty)
|
|
1483
|
+
*/
|
|
1484
|
+
removeAllColumns(): Column[];
|
|
1485
|
+
/**
|
|
1486
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1487
|
+
* will not be supported anymore from 1.38.
|
|
1488
|
+
*
|
|
1489
|
+
* Removes a column from the aggregation {@link #getColumns columns}.
|
|
1490
|
+
*
|
|
1491
|
+
* @returns The removed column or `null`
|
|
1492
|
+
*/
|
|
1493
|
+
removeColumn(
|
|
1494
|
+
/**
|
|
1495
|
+
* The column to remove or its index or id
|
|
1496
|
+
*/
|
|
1497
|
+
vColumn: int | string | Column
|
|
1498
|
+
): Column | null;
|
|
1499
|
+
/**
|
|
1500
|
+
* Sets a new value for property {@link #getHeight height}.
|
|
1501
|
+
*
|
|
1502
|
+
* The height of the Chart
|
|
1503
|
+
*
|
|
1504
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1505
|
+
*
|
|
1506
|
+
* Default value is `'100%'`.
|
|
1507
|
+
*
|
|
1508
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1509
|
+
*/
|
|
1510
|
+
setHeight(
|
|
1511
|
+
/**
|
|
1512
|
+
* New value for property `height`
|
|
1513
|
+
*/
|
|
1514
|
+
sHeight?: CSSSize
|
|
1515
|
+
): this;
|
|
1516
|
+
/**
|
|
1517
|
+
* Sets a new value for property {@link #getLegendPosition legendPosition}.
|
|
1518
|
+
*
|
|
1519
|
+
* Legend position all chart types except Bar chart. Default position for Pie/Donut chart is Left. All other
|
|
1520
|
+
* chart's default position is None. Note: the default legend position is set when the chart type is set
|
|
1521
|
+
* first time, subsequent change to the chart type will keep using initial legend position unless it is
|
|
1522
|
+
* changed explicitly by user.
|
|
1523
|
+
*
|
|
1524
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1525
|
+
*
|
|
1526
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1527
|
+
*/
|
|
1528
|
+
setLegendPosition(
|
|
1529
|
+
/**
|
|
1530
|
+
* New value for property `legendPosition`
|
|
1531
|
+
*/
|
|
1532
|
+
sLegendPosition?: LegendPosition | keyof typeof LegendPosition
|
|
1533
|
+
): this;
|
|
1534
|
+
/**
|
|
1535
|
+
* Sets a new value for property {@link #getLineThickness lineThickness}.
|
|
1536
|
+
*
|
|
1537
|
+
* Specify the line thickness of the line graph. Only applies to Line chart type.
|
|
1538
|
+
*
|
|
1539
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1540
|
+
*
|
|
1541
|
+
* Default value is `1`.
|
|
1542
|
+
*
|
|
1543
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1544
|
+
*/
|
|
1545
|
+
setLineThickness(
|
|
1546
|
+
/**
|
|
1547
|
+
* New value for property `lineThickness`
|
|
1548
|
+
*/
|
|
1549
|
+
fLineThickness?: float
|
|
1550
|
+
): this;
|
|
1551
|
+
/**
|
|
1552
|
+
* Sets a new value for property {@link #getMaxSliceCount maxSliceCount}.
|
|
1553
|
+
*
|
|
1554
|
+
* Set the maximum number of slices in a Pie/Donut chart. If exceeding the specified value, the rest will
|
|
1555
|
+
* be categorised into a single slice. Only applies to Pie/Donut.
|
|
1556
|
+
*
|
|
1557
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1558
|
+
*
|
|
1559
|
+
* Default value is `12`.
|
|
1560
|
+
*
|
|
1561
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1562
|
+
*/
|
|
1563
|
+
setMaxSliceCount(
|
|
1564
|
+
/**
|
|
1565
|
+
* New value for property `maxSliceCount`
|
|
1566
|
+
*/
|
|
1567
|
+
iMaxSliceCount?: int
|
|
1568
|
+
): this;
|
|
1569
|
+
/**
|
|
1570
|
+
* Sets a new value for property {@link #getNumberOfVisibleCategories numberOfVisibleCategories}.
|
|
1571
|
+
*
|
|
1572
|
+
* The number of categories that will be visible on the chart at any time. The minimum value is 2. If not
|
|
1573
|
+
* set, the number of visible categories will be automatically adjusted depending on the screen size
|
|
1574
|
+
*
|
|
1575
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1576
|
+
*
|
|
1577
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1578
|
+
*/
|
|
1579
|
+
setNumberOfVisibleCategories(
|
|
1580
|
+
/**
|
|
1581
|
+
* New value for property `numberOfVisibleCategories`
|
|
1582
|
+
*/
|
|
1583
|
+
iNumberOfVisibleCategories?: int
|
|
1584
|
+
): this;
|
|
1585
|
+
/**
|
|
1586
|
+
* Sets a new value for property {@link #getRangeSelectorStartPosition rangeSelectorStartPosition}.
|
|
1587
|
+
*
|
|
1588
|
+
* Specify the range selector start position, default value is 0.
|
|
1589
|
+
*
|
|
1590
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1591
|
+
*
|
|
1592
|
+
* Default value is `0`.
|
|
1593
|
+
*
|
|
1594
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1595
|
+
*/
|
|
1596
|
+
setRangeSelectorStartPosition(
|
|
1597
|
+
/**
|
|
1598
|
+
* New value for property `rangeSelectorStartPosition`
|
|
1599
|
+
*/
|
|
1600
|
+
iRangeSelectorStartPosition?: int
|
|
1601
|
+
): this;
|
|
1602
|
+
/**
|
|
1603
|
+
* Sets a new value for property {@link #getShowRangeSelector showRangeSelector}.
|
|
1604
|
+
*
|
|
1605
|
+
* Specify whether the range selector should be visible.
|
|
1606
|
+
*
|
|
1607
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1608
|
+
*
|
|
1609
|
+
* Default value is `true`.
|
|
1610
|
+
*
|
|
1611
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1612
|
+
*/
|
|
1613
|
+
setShowRangeSelector(
|
|
1614
|
+
/**
|
|
1615
|
+
* New value for property `showRangeSelector`
|
|
1616
|
+
*/
|
|
1617
|
+
bShowRangeSelector?: boolean
|
|
1618
|
+
): this;
|
|
1619
|
+
/**
|
|
1620
|
+
* Sets a new value for property {@link #getShowTableValue showTableValue}.
|
|
1621
|
+
*
|
|
1622
|
+
* Toggle to display the table value on a Bar chart. Only applies to Bar chart.
|
|
1623
|
+
*
|
|
1624
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1625
|
+
*
|
|
1626
|
+
* Default value is `true`.
|
|
1627
|
+
*
|
|
1628
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1629
|
+
*/
|
|
1630
|
+
setShowTableValue(
|
|
1631
|
+
/**
|
|
1632
|
+
* New value for property `showTableValue`
|
|
1633
|
+
*/
|
|
1634
|
+
bShowTableValue?: boolean
|
|
1635
|
+
): this;
|
|
1636
|
+
/**
|
|
1637
|
+
* Sets a new value for property {@link #getShowTableView showTableView}.
|
|
1638
|
+
*
|
|
1639
|
+
* Toggle to display table view
|
|
1640
|
+
*
|
|
1641
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1642
|
+
*
|
|
1643
|
+
* Default value is `false`.
|
|
1644
|
+
*
|
|
1645
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1646
|
+
*/
|
|
1647
|
+
setShowTableView(
|
|
1648
|
+
/**
|
|
1649
|
+
* New value for property `showTableView`
|
|
1650
|
+
*/
|
|
1651
|
+
bShowTableView?: boolean
|
|
1652
|
+
): this;
|
|
1653
|
+
/**
|
|
1654
|
+
* Sets a new value for property {@link #getShowTotalValue showTotalValue}.
|
|
1655
|
+
*
|
|
1656
|
+
* Specify whether to show the sum of the value for Waterfall/Waterfall Bar chart. Only applies to Waterfall/WaterfallBar
|
|
1657
|
+
* chart.
|
|
1658
|
+
*
|
|
1659
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1660
|
+
*
|
|
1661
|
+
* Default value is `false`.
|
|
1662
|
+
*
|
|
1663
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1664
|
+
*/
|
|
1665
|
+
setShowTotalValue(
|
|
1666
|
+
/**
|
|
1667
|
+
* New value for property `showTotalValue`
|
|
1668
|
+
*/
|
|
1669
|
+
bShowTotalValue?: boolean
|
|
1670
|
+
): this;
|
|
1671
|
+
/**
|
|
1672
|
+
* Sets a new value for property {@link #getType type}.
|
|
1673
|
+
*
|
|
1674
|
+
* Chart type
|
|
1675
|
+
*
|
|
1676
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1677
|
+
*
|
|
1678
|
+
* Default value is `Column`.
|
|
1679
|
+
*
|
|
1680
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1681
|
+
*/
|
|
1682
|
+
setType(
|
|
1683
|
+
/**
|
|
1684
|
+
* New value for property `type`
|
|
1685
|
+
*/
|
|
1686
|
+
sType?: ChartType | keyof typeof ChartType
|
|
1687
|
+
): this;
|
|
1688
|
+
/**
|
|
1689
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
1690
|
+
*
|
|
1691
|
+
* The width of the Chart
|
|
1692
|
+
*
|
|
1693
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1694
|
+
*
|
|
1695
|
+
* Default value is `'100%'`.
|
|
1696
|
+
*
|
|
1697
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1698
|
+
*/
|
|
1699
|
+
setWidth(
|
|
1700
|
+
/**
|
|
1701
|
+
* New value for property `width`
|
|
1702
|
+
*/
|
|
1703
|
+
sWidth?: CSSSize
|
|
1704
|
+
): this;
|
|
1705
|
+
/**
|
|
1706
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1707
|
+
* will not be supported anymore from 1.38.
|
|
1708
|
+
*
|
|
1709
|
+
* Unbinds aggregation {@link #getColumns columns} from model data.
|
|
1710
|
+
*
|
|
1711
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1712
|
+
*/
|
|
1713
|
+
unbindColumns(): this;
|
|
1714
|
+
/**
|
|
1715
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1716
|
+
* will not be supported anymore from 1.38.
|
|
1717
|
+
*
|
|
1718
|
+
* Unbinds aggregation {@link #getRows rows} from model data.
|
|
1719
|
+
*
|
|
1720
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1721
|
+
*/
|
|
1722
|
+
unbindRows(): this;
|
|
1723
|
+
}
|
|
1724
|
+
|
|
1725
|
+
export interface $ChartSettings extends $ControlSettings {
|
|
1726
|
+
/**
|
|
1727
|
+
* The width of the Chart
|
|
1728
|
+
*/
|
|
1729
|
+
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
1730
|
+
|
|
1731
|
+
/**
|
|
1732
|
+
* The height of the Chart
|
|
1733
|
+
*/
|
|
1734
|
+
height?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
1735
|
+
|
|
1736
|
+
/**
|
|
1737
|
+
* Chart type
|
|
1738
|
+
*/
|
|
1739
|
+
type?:
|
|
1740
|
+
| (ChartType | keyof typeof ChartType)
|
|
1741
|
+
| PropertyBindingInfo
|
|
1742
|
+
| `{${string}}`;
|
|
1743
|
+
|
|
1744
|
+
/**
|
|
1745
|
+
* Specify whether the range selector should be visible.
|
|
1746
|
+
*/
|
|
1747
|
+
showRangeSelector?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1748
|
+
|
|
1749
|
+
/**
|
|
1750
|
+
* Toggle to display table view
|
|
1751
|
+
*/
|
|
1752
|
+
showTableView?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1753
|
+
|
|
1754
|
+
/**
|
|
1755
|
+
* Legend position all chart types except Bar chart. Default position for Pie/Donut chart is Left. All other
|
|
1756
|
+
* chart's default position is None. Note: the default legend position is set when the chart type is set
|
|
1757
|
+
* first time, subsequent change to the chart type will keep using initial legend position unless it is
|
|
1758
|
+
* changed explicitly by user.
|
|
1759
|
+
*/
|
|
1760
|
+
legendPosition?:
|
|
1761
|
+
| (LegendPosition | keyof typeof LegendPosition)
|
|
1762
|
+
| PropertyBindingInfo
|
|
1763
|
+
| `{${string}}`;
|
|
1764
|
+
|
|
1765
|
+
/**
|
|
1766
|
+
* Specify the line thickness of the line graph. Only applies to Line chart type.
|
|
1767
|
+
*/
|
|
1768
|
+
lineThickness?: float | PropertyBindingInfo | `{${string}}`;
|
|
1769
|
+
|
|
1770
|
+
/**
|
|
1771
|
+
* Toggle to display the table value on a Bar chart. Only applies to Bar chart.
|
|
1772
|
+
*/
|
|
1773
|
+
showTableValue?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1774
|
+
|
|
1775
|
+
/**
|
|
1776
|
+
* Set the maximum number of slices in a Pie/Donut chart. If exceeding the specified value, the rest will
|
|
1777
|
+
* be categorised into a single slice. Only applies to Pie/Donut.
|
|
1778
|
+
*/
|
|
1779
|
+
maxSliceCount?: int | PropertyBindingInfo | `{${string}}`;
|
|
1780
|
+
|
|
1781
|
+
/**
|
|
1782
|
+
* Allow a chart’s color palette to be modified without affecting the other charts' color palette. If not
|
|
1783
|
+
* set, the chart will use the default color palette defined in the theme. Accept an array of color in string
|
|
1784
|
+
* format or hex format. e.g. 0xff0000 "red" "rgb(255,0,0)"
|
|
1785
|
+
*/
|
|
1786
|
+
primaryColorPalette?: any | PropertyBindingInfo | `{${string}}`;
|
|
1787
|
+
|
|
1788
|
+
/**
|
|
1789
|
+
* Specify whether to show the sum of the value for Waterfall/Waterfall Bar chart. Only applies to Waterfall/WaterfallBar
|
|
1790
|
+
* chart.
|
|
1791
|
+
*/
|
|
1792
|
+
showTotalValue?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1793
|
+
|
|
1794
|
+
/**
|
|
1795
|
+
* The number of categories that will be visible on the chart at any time. The minimum value is 2. If not
|
|
1796
|
+
* set, the number of visible categories will be automatically adjusted depending on the screen size
|
|
1797
|
+
*/
|
|
1798
|
+
numberOfVisibleCategories?: int | PropertyBindingInfo | `{${string}}`;
|
|
1799
|
+
|
|
1800
|
+
/**
|
|
1801
|
+
* Specify the range selector start position, default value is 0.
|
|
1802
|
+
*/
|
|
1803
|
+
rangeSelectorStartPosition?: int | PropertyBindingInfo | `{${string}}`;
|
|
1804
|
+
|
|
1805
|
+
/**
|
|
1806
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1807
|
+
* will not be supported anymore from 1.38.
|
|
1808
|
+
*
|
|
1809
|
+
* The data rows of the chart. User should bind these to their data source
|
|
1810
|
+
*/
|
|
1811
|
+
rows?: Row[] | Row | AggregationBindingInfo | `{${string}}`;
|
|
1812
|
+
|
|
1813
|
+
/**
|
|
1814
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1815
|
+
* will not be supported anymore from 1.38.
|
|
1816
|
+
*
|
|
1817
|
+
* The data column map of the chart.
|
|
1818
|
+
*/
|
|
1819
|
+
columns?: Column[] | Column | AggregationBindingInfo | `{${string}}`;
|
|
1820
|
+
|
|
1821
|
+
/**
|
|
1822
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1823
|
+
* will not be supported anymore from 1.38.
|
|
1824
|
+
*
|
|
1825
|
+
* Data region property of the chart's Series
|
|
1826
|
+
*/
|
|
1827
|
+
series?: Series;
|
|
1828
|
+
|
|
1829
|
+
/**
|
|
1830
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1831
|
+
* will not be supported anymore from 1.38.
|
|
1832
|
+
*
|
|
1833
|
+
* Data region property of the chart's Values
|
|
1834
|
+
*/
|
|
1835
|
+
values?: Value[] | Value | AggregationBindingInfo | `{${string}}`;
|
|
1836
|
+
|
|
1837
|
+
/**
|
|
1838
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1839
|
+
* will not be supported anymore from 1.38.
|
|
1840
|
+
*
|
|
1841
|
+
* Data region property of the chart's Categories
|
|
1842
|
+
*/
|
|
1843
|
+
categoryRegions?:
|
|
1844
|
+
| Category[]
|
|
1845
|
+
| Category
|
|
1846
|
+
| AggregationBindingInfo
|
|
1847
|
+
| `{${string}}`;
|
|
1848
|
+
|
|
1849
|
+
/**
|
|
1850
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1851
|
+
* will not be supported anymore from 1.38.
|
|
1852
|
+
*
|
|
1853
|
+
* Data region property of the chart's Category
|
|
1854
|
+
*/
|
|
1855
|
+
category?: Category;
|
|
1856
|
+
|
|
1857
|
+
/**
|
|
1858
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1859
|
+
* will not be supported anymore from 1.38.
|
|
1860
|
+
*
|
|
1861
|
+
* Category Axis property of the Chart. Accepts only an instance of CategoryAxis element.
|
|
1862
|
+
*/
|
|
1863
|
+
categoryAxis?: CategoryAxis;
|
|
1864
|
+
|
|
1865
|
+
/**
|
|
1866
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1867
|
+
* will not be supported anymore from 1.38.
|
|
1868
|
+
*
|
|
1869
|
+
* Value Axis property of the Chart. Accept only an instance of ValueAxis element.
|
|
1870
|
+
*/
|
|
1871
|
+
valueAxis?: ValueAxis;
|
|
1872
|
+
|
|
1873
|
+
/**
|
|
1874
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1875
|
+
* will not be supported anymore from 1.38.
|
|
1876
|
+
*
|
|
1877
|
+
* Value Bubble property of the Chart. Accept only an instance of ValueBubble element.
|
|
1878
|
+
*/
|
|
1879
|
+
valueBubble?: ValueBubble;
|
|
1880
|
+
|
|
1881
|
+
/**
|
|
1882
|
+
* Double tap event on the chart
|
|
1883
|
+
*/
|
|
1884
|
+
doubletap?: (oEvent: Event) => void;
|
|
1885
|
+
|
|
1886
|
+
/**
|
|
1887
|
+
* Single tap event on the chart
|
|
1888
|
+
*/
|
|
1889
|
+
tap?: (oEvent: Event) => void;
|
|
1890
|
+
|
|
1891
|
+
/**
|
|
1892
|
+
* Long press event on the chart
|
|
1893
|
+
*/
|
|
1894
|
+
longpress?: (oEvent: Event) => void;
|
|
1895
|
+
}
|
|
1896
|
+
}
|
|
1897
|
+
|
|
1898
|
+
declare module "sap/makit/Column" {
|
|
1899
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
1900
|
+
|
|
1901
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1902
|
+
|
|
1903
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
1904
|
+
|
|
1905
|
+
/**
|
|
1906
|
+
* @SINCE 1.8
|
|
1907
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
1908
|
+
* will not be supported anymore from 1.38.
|
|
1909
|
+
*
|
|
1910
|
+
* The data column of the Chart's data table
|
|
1911
|
+
*/
|
|
1912
|
+
export default class Column extends UI5Element {
|
|
1913
|
+
/**
|
|
1914
|
+
* Constructor for a new Column.
|
|
1915
|
+
*
|
|
1916
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1917
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1918
|
+
* of the syntax of the settings object.
|
|
1919
|
+
*/
|
|
1920
|
+
constructor(
|
|
1921
|
+
/**
|
|
1922
|
+
* initial settings for the new control
|
|
1923
|
+
*/
|
|
1924
|
+
mSettings?: $ColumnSettings
|
|
1925
|
+
);
|
|
1926
|
+
/**
|
|
1927
|
+
* Constructor for a new Column.
|
|
1928
|
+
*
|
|
1929
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1930
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1931
|
+
* of the syntax of the settings object.
|
|
1932
|
+
*/
|
|
1933
|
+
constructor(
|
|
1934
|
+
/**
|
|
1935
|
+
* id for the new control, generated automatically if no id is given
|
|
1936
|
+
*/
|
|
1937
|
+
sId?: string,
|
|
1938
|
+
/**
|
|
1939
|
+
* initial settings for the new control
|
|
1940
|
+
*/
|
|
1941
|
+
mSettings?: $ColumnSettings
|
|
1942
|
+
);
|
|
1943
|
+
|
|
1944
|
+
/**
|
|
1945
|
+
* Creates a new subclass of class sap.makit.Column with name `sClassName` and enriches it with the information
|
|
1946
|
+
* contained in `oClassInfo`.
|
|
1947
|
+
*
|
|
1948
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
1949
|
+
*
|
|
1950
|
+
* @returns Created class / constructor function
|
|
1951
|
+
*/
|
|
1952
|
+
static extend<T extends Record<string, unknown>>(
|
|
1953
|
+
/**
|
|
1954
|
+
* Name of the class being created
|
|
1955
|
+
*/
|
|
1956
|
+
sClassName: string,
|
|
1957
|
+
/**
|
|
1958
|
+
* Object literal with information about the class
|
|
1959
|
+
*/
|
|
1960
|
+
oClassInfo?: sap.ClassInfo<T, Column>,
|
|
1961
|
+
/**
|
|
1962
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1963
|
+
* used by this class
|
|
1964
|
+
*/
|
|
1965
|
+
FNMetaImpl?: Function
|
|
1966
|
+
): Function;
|
|
1967
|
+
/**
|
|
1968
|
+
* Returns a metadata object for class sap.makit.Column.
|
|
1969
|
+
*
|
|
1970
|
+
* @returns Metadata object describing this class
|
|
1971
|
+
*/
|
|
1972
|
+
static getMetadata(): ElementMetadata;
|
|
1973
|
+
/**
|
|
1974
|
+
* Gets current value of property {@link #getName name}.
|
|
1975
|
+
*
|
|
1976
|
+
* The name representing the Column
|
|
1977
|
+
*
|
|
1978
|
+
* @returns Value of property `name`
|
|
1979
|
+
*/
|
|
1980
|
+
getName(): string;
|
|
1981
|
+
/**
|
|
1982
|
+
* Gets current value of property {@link #getType type}.
|
|
1983
|
+
*
|
|
1984
|
+
* The data type of the Column: number string datetime
|
|
1985
|
+
*
|
|
1986
|
+
* Default value is `'string'`.
|
|
1987
|
+
*
|
|
1988
|
+
* @returns Value of property `type`
|
|
1989
|
+
*/
|
|
1990
|
+
getType(): string;
|
|
1991
|
+
/**
|
|
1992
|
+
* Gets current value of property {@link #getValue value}.
|
|
1993
|
+
*
|
|
1994
|
+
* The value mapped to this Column (User should map this using data binding)
|
|
1995
|
+
*
|
|
1996
|
+
* @returns Value of property `value`
|
|
1997
|
+
*/
|
|
1998
|
+
getValue(): any;
|
|
1999
|
+
/**
|
|
2000
|
+
* Sets a new value for property {@link #getName name}.
|
|
2001
|
+
*
|
|
2002
|
+
* The name representing the Column
|
|
2003
|
+
*
|
|
2004
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2005
|
+
*
|
|
2006
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2007
|
+
*/
|
|
2008
|
+
setName(
|
|
2009
|
+
/**
|
|
2010
|
+
* New value for property `name`
|
|
2011
|
+
*/
|
|
2012
|
+
sName?: string
|
|
2013
|
+
): this;
|
|
2014
|
+
/**
|
|
2015
|
+
* Sets a new value for property {@link #getType type}.
|
|
2016
|
+
*
|
|
2017
|
+
* The data type of the Column: number string datetime
|
|
2018
|
+
*
|
|
2019
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2020
|
+
*
|
|
2021
|
+
* Default value is `'string'`.
|
|
2022
|
+
*
|
|
2023
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2024
|
+
*/
|
|
2025
|
+
setType(
|
|
2026
|
+
/**
|
|
2027
|
+
* New value for property `type`
|
|
2028
|
+
*/
|
|
2029
|
+
sType?: string
|
|
2030
|
+
): this;
|
|
2031
|
+
/**
|
|
2032
|
+
* Sets a new value for property {@link #getValue value}.
|
|
2033
|
+
*
|
|
2034
|
+
* The value mapped to this Column (User should map this using data binding)
|
|
2035
|
+
*
|
|
2036
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2037
|
+
*
|
|
2038
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2039
|
+
*/
|
|
2040
|
+
setValue(
|
|
2041
|
+
/**
|
|
2042
|
+
* New value for property `value`
|
|
2043
|
+
*/
|
|
2044
|
+
oValue?: any
|
|
2045
|
+
): this;
|
|
2046
|
+
}
|
|
2047
|
+
|
|
2048
|
+
export interface $ColumnSettings extends $ElementSettings {
|
|
2049
|
+
/**
|
|
2050
|
+
* The name representing the Column
|
|
2051
|
+
*/
|
|
2052
|
+
name?: string | PropertyBindingInfo;
|
|
2053
|
+
|
|
2054
|
+
/**
|
|
2055
|
+
* The value mapped to this Column (User should map this using data binding)
|
|
2056
|
+
*/
|
|
2057
|
+
value?: any | PropertyBindingInfo | `{${string}}`;
|
|
2058
|
+
|
|
2059
|
+
/**
|
|
2060
|
+
* The data type of the Column: number string datetime
|
|
2061
|
+
*/
|
|
2062
|
+
type?: string | PropertyBindingInfo;
|
|
2063
|
+
}
|
|
2064
|
+
}
|
|
2065
|
+
|
|
2066
|
+
declare module "sap/makit/CombinationChart" {
|
|
2067
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
2068
|
+
|
|
2069
|
+
import Event from "sap/ui/base/Event";
|
|
2070
|
+
|
|
2071
|
+
import CategoryAxis from "sap/makit/CategoryAxis";
|
|
2072
|
+
|
|
2073
|
+
import Category from "sap/makit/Category";
|
|
2074
|
+
|
|
2075
|
+
import { CSSSize } from "sap/ui/core/library";
|
|
2076
|
+
|
|
2077
|
+
import Layer from "sap/makit/Layer";
|
|
2078
|
+
|
|
2079
|
+
import { LegendPosition } from "sap/makit/library";
|
|
2080
|
+
|
|
2081
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
2082
|
+
|
|
2083
|
+
import ValueAxis from "sap/makit/ValueAxis";
|
|
2084
|
+
|
|
2085
|
+
import ValueBubble from "sap/makit/ValueBubble";
|
|
2086
|
+
|
|
2087
|
+
import {
|
|
2088
|
+
PropertyBindingInfo,
|
|
2089
|
+
AggregationBindingInfo,
|
|
2090
|
+
} from "sap/ui/base/ManagedObject";
|
|
2091
|
+
|
|
2092
|
+
/**
|
|
2093
|
+
* @SINCE 1.12
|
|
2094
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2095
|
+
* will not be supported anymore from 1.38.
|
|
2096
|
+
*
|
|
2097
|
+
* The CombinationChart control.
|
|
2098
|
+
*/
|
|
2099
|
+
export default class CombinationChart extends Control {
|
|
2100
|
+
/**
|
|
2101
|
+
* Constructor for a new CombinationChart.
|
|
2102
|
+
*
|
|
2103
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2104
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2105
|
+
* of the syntax of the settings object.
|
|
2106
|
+
*/
|
|
2107
|
+
constructor(
|
|
2108
|
+
/**
|
|
2109
|
+
* initial settings for the new control
|
|
2110
|
+
*/
|
|
2111
|
+
mSettings?: $CombinationChartSettings
|
|
2112
|
+
);
|
|
2113
|
+
/**
|
|
2114
|
+
* Constructor for a new CombinationChart.
|
|
2115
|
+
*
|
|
2116
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2117
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2118
|
+
* of the syntax of the settings object.
|
|
2119
|
+
*/
|
|
2120
|
+
constructor(
|
|
2121
|
+
/**
|
|
2122
|
+
* id for the new control, generated automatically if no id is given
|
|
2123
|
+
*/
|
|
2124
|
+
sId?: string,
|
|
2125
|
+
/**
|
|
2126
|
+
* initial settings for the new control
|
|
2127
|
+
*/
|
|
2128
|
+
mSettings?: $CombinationChartSettings
|
|
2129
|
+
);
|
|
2130
|
+
|
|
2131
|
+
/**
|
|
2132
|
+
* Creates a new subclass of class sap.makit.CombinationChart with name `sClassName` and enriches it with
|
|
2133
|
+
* the information contained in `oClassInfo`.
|
|
2134
|
+
*
|
|
2135
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
2136
|
+
*
|
|
2137
|
+
* @returns Created class / constructor function
|
|
2138
|
+
*/
|
|
2139
|
+
static extend<T extends Record<string, unknown>>(
|
|
2140
|
+
/**
|
|
2141
|
+
* Name of the class being created
|
|
2142
|
+
*/
|
|
2143
|
+
sClassName: string,
|
|
2144
|
+
/**
|
|
2145
|
+
* Object literal with information about the class
|
|
2146
|
+
*/
|
|
2147
|
+
oClassInfo?: sap.ClassInfo<T, CombinationChart>,
|
|
2148
|
+
/**
|
|
2149
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2150
|
+
* used by this class
|
|
2151
|
+
*/
|
|
2152
|
+
FNMetaImpl?: Function
|
|
2153
|
+
): Function;
|
|
2154
|
+
/**
|
|
2155
|
+
* Returns a metadata object for class sap.makit.CombinationChart.
|
|
2156
|
+
*
|
|
2157
|
+
* @returns Metadata object describing this class
|
|
2158
|
+
*/
|
|
2159
|
+
static getMetadata(): ElementMetadata;
|
|
2160
|
+
/**
|
|
2161
|
+
* Attaches event handler `fnFunction` to the {@link #event:doubletap doubletap} event of this `sap.makit.CombinationChart`.
|
|
2162
|
+
*
|
|
2163
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2164
|
+
* otherwise it will be bound to this `sap.makit.CombinationChart` itself.
|
|
2165
|
+
*
|
|
2166
|
+
* Double tap event on the chart
|
|
2167
|
+
*
|
|
2168
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2169
|
+
*/
|
|
2170
|
+
attachDoubletap(
|
|
2171
|
+
/**
|
|
2172
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
2173
|
+
* object when firing the event
|
|
2174
|
+
*/
|
|
2175
|
+
oData: object,
|
|
2176
|
+
/**
|
|
2177
|
+
* The function to be called when the event occurs
|
|
2178
|
+
*/
|
|
2179
|
+
fnFunction: (p1: Event) => void,
|
|
2180
|
+
/**
|
|
2181
|
+
* Context object to call the event handler with. Defaults to this `sap.makit.CombinationChart` itself
|
|
2182
|
+
*/
|
|
2183
|
+
oListener?: object
|
|
2184
|
+
): this;
|
|
2185
|
+
/**
|
|
2186
|
+
* Attaches event handler `fnFunction` to the {@link #event:doubletap doubletap} event of this `sap.makit.CombinationChart`.
|
|
2187
|
+
*
|
|
2188
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2189
|
+
* otherwise it will be bound to this `sap.makit.CombinationChart` itself.
|
|
2190
|
+
*
|
|
2191
|
+
* Double tap event on the chart
|
|
2192
|
+
*
|
|
2193
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2194
|
+
*/
|
|
2195
|
+
attachDoubletap(
|
|
2196
|
+
/**
|
|
2197
|
+
* The function to be called when the event occurs
|
|
2198
|
+
*/
|
|
2199
|
+
fnFunction: (p1: Event) => void,
|
|
2200
|
+
/**
|
|
2201
|
+
* Context object to call the event handler with. Defaults to this `sap.makit.CombinationChart` itself
|
|
2202
|
+
*/
|
|
2203
|
+
oListener?: object
|
|
2204
|
+
): this;
|
|
2205
|
+
/**
|
|
2206
|
+
* Attaches event handler `fnFunction` to the {@link #event:longpress longpress} event of this `sap.makit.CombinationChart`.
|
|
2207
|
+
*
|
|
2208
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2209
|
+
* otherwise it will be bound to this `sap.makit.CombinationChart` itself.
|
|
2210
|
+
*
|
|
2211
|
+
* Long press event on the chart
|
|
2212
|
+
*
|
|
2213
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2214
|
+
*/
|
|
2215
|
+
attachLongpress(
|
|
2216
|
+
/**
|
|
2217
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
2218
|
+
* object when firing the event
|
|
2219
|
+
*/
|
|
2220
|
+
oData: object,
|
|
2221
|
+
/**
|
|
2222
|
+
* The function to be called when the event occurs
|
|
2223
|
+
*/
|
|
2224
|
+
fnFunction: (p1: Event) => void,
|
|
2225
|
+
/**
|
|
2226
|
+
* Context object to call the event handler with. Defaults to this `sap.makit.CombinationChart` itself
|
|
2227
|
+
*/
|
|
2228
|
+
oListener?: object
|
|
2229
|
+
): this;
|
|
2230
|
+
/**
|
|
2231
|
+
* Attaches event handler `fnFunction` to the {@link #event:longpress longpress} event of this `sap.makit.CombinationChart`.
|
|
2232
|
+
*
|
|
2233
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2234
|
+
* otherwise it will be bound to this `sap.makit.CombinationChart` itself.
|
|
2235
|
+
*
|
|
2236
|
+
* Long press event on the chart
|
|
2237
|
+
*
|
|
2238
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2239
|
+
*/
|
|
2240
|
+
attachLongpress(
|
|
2241
|
+
/**
|
|
2242
|
+
* The function to be called when the event occurs
|
|
2243
|
+
*/
|
|
2244
|
+
fnFunction: (p1: Event) => void,
|
|
2245
|
+
/**
|
|
2246
|
+
* Context object to call the event handler with. Defaults to this `sap.makit.CombinationChart` itself
|
|
2247
|
+
*/
|
|
2248
|
+
oListener?: object
|
|
2249
|
+
): this;
|
|
2250
|
+
/**
|
|
2251
|
+
* Attaches event handler `fnFunction` to the {@link #event:tap tap} event of this `sap.makit.CombinationChart`.
|
|
2252
|
+
*
|
|
2253
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2254
|
+
* otherwise it will be bound to this `sap.makit.CombinationChart` itself.
|
|
2255
|
+
*
|
|
2256
|
+
* Single tap event on the chart
|
|
2257
|
+
*
|
|
2258
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2259
|
+
*/
|
|
2260
|
+
attachTap(
|
|
2261
|
+
/**
|
|
2262
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
2263
|
+
* object when firing the event
|
|
2264
|
+
*/
|
|
2265
|
+
oData: object,
|
|
2266
|
+
/**
|
|
2267
|
+
* The function to be called when the event occurs
|
|
2268
|
+
*/
|
|
2269
|
+
fnFunction: (p1: Event) => void,
|
|
2270
|
+
/**
|
|
2271
|
+
* Context object to call the event handler with. Defaults to this `sap.makit.CombinationChart` itself
|
|
2272
|
+
*/
|
|
2273
|
+
oListener?: object
|
|
2274
|
+
): this;
|
|
2275
|
+
/**
|
|
2276
|
+
* Attaches event handler `fnFunction` to the {@link #event:tap tap} event of this `sap.makit.CombinationChart`.
|
|
2277
|
+
*
|
|
2278
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2279
|
+
* otherwise it will be bound to this `sap.makit.CombinationChart` itself.
|
|
2280
|
+
*
|
|
2281
|
+
* Single tap event on the chart
|
|
2282
|
+
*
|
|
2283
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2284
|
+
*/
|
|
2285
|
+
attachTap(
|
|
2286
|
+
/**
|
|
2287
|
+
* The function to be called when the event occurs
|
|
2288
|
+
*/
|
|
2289
|
+
fnFunction: (p1: Event) => void,
|
|
2290
|
+
/**
|
|
2291
|
+
* Context object to call the event handler with. Defaults to this `sap.makit.CombinationChart` itself
|
|
2292
|
+
*/
|
|
2293
|
+
oListener?: object
|
|
2294
|
+
): this;
|
|
2295
|
+
/**
|
|
2296
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2297
|
+
* will not be supported anymore from 1.38.
|
|
2298
|
+
*
|
|
2299
|
+
* Destroys the categoryAxis in the aggregation {@link #getCategoryAxis categoryAxis}.
|
|
2300
|
+
*
|
|
2301
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2302
|
+
*/
|
|
2303
|
+
destroyCategoryAxis(): this;
|
|
2304
|
+
/**
|
|
2305
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2306
|
+
* will not be supported anymore from 1.38.
|
|
2307
|
+
*
|
|
2308
|
+
* Destroys all the categoryRegions in the aggregation {@link #getCategoryRegions categoryRegions}.
|
|
2309
|
+
*
|
|
2310
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2311
|
+
*/
|
|
2312
|
+
destroyCategoryRegions(): this;
|
|
2313
|
+
/**
|
|
2314
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2315
|
+
* will not be supported anymore from 1.38.
|
|
2316
|
+
*
|
|
2317
|
+
* Destroys all the layers in the aggregation {@link #getLayers layers}.
|
|
2318
|
+
*
|
|
2319
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2320
|
+
*/
|
|
2321
|
+
destroyLayers(): this;
|
|
2322
|
+
/**
|
|
2323
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2324
|
+
* will not be supported anymore from 1.38.
|
|
2325
|
+
*
|
|
2326
|
+
* Destroys the primaryValueAxis in the aggregation {@link #getPrimaryValueAxis primaryValueAxis}.
|
|
2327
|
+
*
|
|
2328
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2329
|
+
*/
|
|
2330
|
+
destroyPrimaryValueAxis(): this;
|
|
2331
|
+
/**
|
|
2332
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2333
|
+
* will not be supported anymore from 1.38.
|
|
2334
|
+
*
|
|
2335
|
+
* Destroys the secondaryValueAxis in the aggregation {@link #getSecondaryValueAxis secondaryValueAxis}.
|
|
2336
|
+
*
|
|
2337
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2338
|
+
*/
|
|
2339
|
+
destroySecondaryValueAxis(): this;
|
|
2340
|
+
/**
|
|
2341
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2342
|
+
* will not be supported anymore from 1.38.
|
|
2343
|
+
*
|
|
2344
|
+
* Destroys the valueBubble in the aggregation {@link #getValueBubble valueBubble}.
|
|
2345
|
+
*
|
|
2346
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2347
|
+
*/
|
|
2348
|
+
destroyValueBubble(): this;
|
|
2349
|
+
/**
|
|
2350
|
+
* Detaches event handler `fnFunction` from the {@link #event:doubletap doubletap} event of this `sap.makit.CombinationChart`.
|
|
2351
|
+
*
|
|
2352
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
2353
|
+
*
|
|
2354
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2355
|
+
*/
|
|
2356
|
+
detachDoubletap(
|
|
2357
|
+
/**
|
|
2358
|
+
* The function to be called, when the event occurs
|
|
2359
|
+
*/
|
|
2360
|
+
fnFunction: (p1: Event) => void,
|
|
2361
|
+
/**
|
|
2362
|
+
* Context object on which the given function had to be called
|
|
2363
|
+
*/
|
|
2364
|
+
oListener?: object
|
|
2365
|
+
): this;
|
|
2366
|
+
/**
|
|
2367
|
+
* Detaches event handler `fnFunction` from the {@link #event:longpress longpress} event of this `sap.makit.CombinationChart`.
|
|
2368
|
+
*
|
|
2369
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
2370
|
+
*
|
|
2371
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2372
|
+
*/
|
|
2373
|
+
detachLongpress(
|
|
2374
|
+
/**
|
|
2375
|
+
* The function to be called, when the event occurs
|
|
2376
|
+
*/
|
|
2377
|
+
fnFunction: (p1: Event) => void,
|
|
2378
|
+
/**
|
|
2379
|
+
* Context object on which the given function had to be called
|
|
2380
|
+
*/
|
|
2381
|
+
oListener?: object
|
|
2382
|
+
): this;
|
|
2383
|
+
/**
|
|
2384
|
+
* Detaches event handler `fnFunction` from the {@link #event:tap tap} event of this `sap.makit.CombinationChart`.
|
|
2385
|
+
*
|
|
2386
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
2387
|
+
*
|
|
2388
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2389
|
+
*/
|
|
2390
|
+
detachTap(
|
|
2391
|
+
/**
|
|
2392
|
+
* The function to be called, when the event occurs
|
|
2393
|
+
*/
|
|
2394
|
+
fnFunction: (p1: Event) => void,
|
|
2395
|
+
/**
|
|
2396
|
+
* Context object on which the given function had to be called
|
|
2397
|
+
*/
|
|
2398
|
+
oListener?: object
|
|
2399
|
+
): this;
|
|
2400
|
+
/**
|
|
2401
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
2402
|
+
*
|
|
2403
|
+
* Fires event {@link #event:doubletap doubletap} to attached listeners.
|
|
2404
|
+
*
|
|
2405
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2406
|
+
*/
|
|
2407
|
+
fireDoubletap(
|
|
2408
|
+
/**
|
|
2409
|
+
* Parameters to pass along with the event
|
|
2410
|
+
*/
|
|
2411
|
+
mParameters?: object
|
|
2412
|
+
): this;
|
|
2413
|
+
/**
|
|
2414
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
2415
|
+
*
|
|
2416
|
+
* Fires event {@link #event:longpress longpress} to attached listeners.
|
|
2417
|
+
*
|
|
2418
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2419
|
+
*/
|
|
2420
|
+
fireLongpress(
|
|
2421
|
+
/**
|
|
2422
|
+
* Parameters to pass along with the event
|
|
2423
|
+
*/
|
|
2424
|
+
mParameters?: object
|
|
2425
|
+
): this;
|
|
2426
|
+
/**
|
|
2427
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
2428
|
+
*
|
|
2429
|
+
* Fires event {@link #event:tap tap} to attached listeners.
|
|
2430
|
+
*
|
|
2431
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2432
|
+
*/
|
|
2433
|
+
fireTap(
|
|
2434
|
+
/**
|
|
2435
|
+
* Parameters to pass along with the event
|
|
2436
|
+
*/
|
|
2437
|
+
mParameters?: object
|
|
2438
|
+
): this;
|
|
2439
|
+
/**
|
|
2440
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2441
|
+
* will not be supported anymore from 1.38.
|
|
2442
|
+
*
|
|
2443
|
+
* Gets content of aggregation {@link #getCategoryAxis categoryAxis}.
|
|
2444
|
+
*
|
|
2445
|
+
* Category Axis property of the Chart. Accepts only an instance of CategoryAxis element.
|
|
2446
|
+
*/
|
|
2447
|
+
getCategoryAxis(): CategoryAxis;
|
|
2448
|
+
/**
|
|
2449
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2450
|
+
* will not be supported anymore from 1.38.
|
|
2451
|
+
*
|
|
2452
|
+
* Gets content of aggregation {@link #getCategoryRegions categoryRegions}.
|
|
2453
|
+
*
|
|
2454
|
+
* Data region property of the chart's Categories
|
|
2455
|
+
*/
|
|
2456
|
+
getCategoryRegions(): Category[];
|
|
2457
|
+
/**
|
|
2458
|
+
* Gets current value of property {@link #getHeight height}.
|
|
2459
|
+
*
|
|
2460
|
+
* The height of the Chart
|
|
2461
|
+
*
|
|
2462
|
+
* Default value is `'100%'`.
|
|
2463
|
+
*
|
|
2464
|
+
* @returns Value of property `height`
|
|
2465
|
+
*/
|
|
2466
|
+
getHeight(): CSSSize;
|
|
2467
|
+
/**
|
|
2468
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2469
|
+
* will not be supported anymore from 1.38.
|
|
2470
|
+
*
|
|
2471
|
+
* Gets content of aggregation {@link #getLayers layers}.
|
|
2472
|
+
*
|
|
2473
|
+
* The collection of charts
|
|
2474
|
+
*/
|
|
2475
|
+
getLayers(): Layer[];
|
|
2476
|
+
/**
|
|
2477
|
+
* Gets current value of property {@link #getLegendPosition legendPosition}.
|
|
2478
|
+
*
|
|
2479
|
+
* Legend position for Pie /Donut chart only.
|
|
2480
|
+
*
|
|
2481
|
+
* Default value is `Left`.
|
|
2482
|
+
*
|
|
2483
|
+
* @returns Value of property `legendPosition`
|
|
2484
|
+
*/
|
|
2485
|
+
getLegendPosition(): LegendPosition | keyof typeof LegendPosition;
|
|
2486
|
+
/**
|
|
2487
|
+
* Get the number of distinct category values
|
|
2488
|
+
*/
|
|
2489
|
+
getNumberOfCategories(): int;
|
|
2490
|
+
/**
|
|
2491
|
+
* Gets current value of property {@link #getNumberOfVisibleCategories numberOfVisibleCategories}.
|
|
2492
|
+
*
|
|
2493
|
+
* The number of categories that will be visible on the chart at any time. The minimum value is 2. If not
|
|
2494
|
+
* set, the number of visible categories will be automatically adjusted depending on the screen size
|
|
2495
|
+
*
|
|
2496
|
+
* @returns Value of property `numberOfVisibleCategories`
|
|
2497
|
+
*/
|
|
2498
|
+
getNumberOfVisibleCategories(): int;
|
|
2499
|
+
/**
|
|
2500
|
+
* Gets current value of property {@link #getPrimaryColorPalette primaryColorPalette}.
|
|
2501
|
+
*
|
|
2502
|
+
* Allow a combination chart’s primary axis color palette to be modified without affecting other charts'
|
|
2503
|
+
* color palette. If not set, the chart will use the default color palette defined in the theme. Accept
|
|
2504
|
+
* an array of color in string format or hex format. e.g. 0xff0000 "red" "rgb(255,0,0)"
|
|
2505
|
+
*
|
|
2506
|
+
* @returns Value of property `primaryColorPalette`
|
|
2507
|
+
*/
|
|
2508
|
+
getPrimaryColorPalette(): any;
|
|
2509
|
+
/**
|
|
2510
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2511
|
+
* will not be supported anymore from 1.38.
|
|
2512
|
+
*
|
|
2513
|
+
* Gets content of aggregation {@link #getPrimaryValueAxis primaryValueAxis}.
|
|
2514
|
+
*
|
|
2515
|
+
* Property of the Combination Chart's primary Value Axis. Accept only an instance of ValueAxis element.
|
|
2516
|
+
*/
|
|
2517
|
+
getPrimaryValueAxis(): ValueAxis;
|
|
2518
|
+
/**
|
|
2519
|
+
* Gets current value of property {@link #getRangeSelectorStartPosition rangeSelectorStartPosition}.
|
|
2520
|
+
*
|
|
2521
|
+
* Specify the range selector start position, default value is 0.
|
|
2522
|
+
*
|
|
2523
|
+
* Default value is `0`.
|
|
2524
|
+
*
|
|
2525
|
+
* @returns Value of property `rangeSelectorStartPosition`
|
|
2526
|
+
*/
|
|
2527
|
+
getRangeSelectorStartPosition(): int;
|
|
2528
|
+
/**
|
|
2529
|
+
* Gets current value of property {@link #getSecondaryColorPalette secondaryColorPalette}.
|
|
2530
|
+
*
|
|
2531
|
+
* Allow a combination chart’s secondary axis color palette to be modified without affecting other charts'
|
|
2532
|
+
* color palette. If not set, the chart will use the default color palette defined in the theme. Accept
|
|
2533
|
+
* an array of color in string format or hex format. e.g. 0xff0000 "red" "rgb(255,0,0)"
|
|
2534
|
+
*
|
|
2535
|
+
* @returns Value of property `secondaryColorPalette`
|
|
2536
|
+
*/
|
|
2537
|
+
getSecondaryColorPalette(): any;
|
|
2538
|
+
/**
|
|
2539
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2540
|
+
* will not be supported anymore from 1.38.
|
|
2541
|
+
*
|
|
2542
|
+
* Gets content of aggregation {@link #getSecondaryValueAxis secondaryValueAxis}.
|
|
2543
|
+
*
|
|
2544
|
+
* Property of the Combination Chart's secondary Value Axis. Accept only an instance of ValueAxis element.
|
|
2545
|
+
*/
|
|
2546
|
+
getSecondaryValueAxis(): ValueAxis;
|
|
2547
|
+
/**
|
|
2548
|
+
* Get the value of the currently highlighted category
|
|
2549
|
+
*/
|
|
2550
|
+
getSelectedCategory(): string;
|
|
2551
|
+
/**
|
|
2552
|
+
* Return an array of categories value that is currently selected.
|
|
2553
|
+
*/
|
|
2554
|
+
getSelectedCategoryGroup(): object;
|
|
2555
|
+
/**
|
|
2556
|
+
* Gets current value of property {@link #getShowRangeSelector showRangeSelector}.
|
|
2557
|
+
*
|
|
2558
|
+
* Specify whether the range selector should be visible.
|
|
2559
|
+
*
|
|
2560
|
+
* Default value is `true`.
|
|
2561
|
+
*
|
|
2562
|
+
* @returns Value of property `showRangeSelector`
|
|
2563
|
+
*/
|
|
2564
|
+
getShowRangeSelector(): boolean;
|
|
2565
|
+
/**
|
|
2566
|
+
* Gets current value of property {@link #getShowTableValue showTableValue}.
|
|
2567
|
+
*
|
|
2568
|
+
* Toggle to display the table value on a Bar chart. Only applies to Bar chart.
|
|
2569
|
+
*
|
|
2570
|
+
* Default value is `true`.
|
|
2571
|
+
*
|
|
2572
|
+
* @returns Value of property `showTableValue`
|
|
2573
|
+
*/
|
|
2574
|
+
getShowTableValue(): boolean;
|
|
2575
|
+
/**
|
|
2576
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2577
|
+
* will not be supported anymore from 1.38.
|
|
2578
|
+
*
|
|
2579
|
+
* Gets content of aggregation {@link #getValueBubble valueBubble}.
|
|
2580
|
+
*
|
|
2581
|
+
* Value Bubble property of the Chart. Accept only an instance of ValueBubble element.
|
|
2582
|
+
*/
|
|
2583
|
+
getValueBubble(): ValueBubble;
|
|
2584
|
+
/**
|
|
2585
|
+
* Gets current value of property {@link #getWidth width}.
|
|
2586
|
+
*
|
|
2587
|
+
* The width of the Chart
|
|
2588
|
+
*
|
|
2589
|
+
* Default value is `'100%'`.
|
|
2590
|
+
*
|
|
2591
|
+
* @returns Value of property `width`
|
|
2592
|
+
*/
|
|
2593
|
+
getWidth(): CSSSize;
|
|
2594
|
+
/**
|
|
2595
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2596
|
+
* will not be supported anymore from 1.38.
|
|
2597
|
+
*
|
|
2598
|
+
* Checks for the provided `sap.makit.Category` in the aggregation {@link #getCategoryRegions categoryRegions}.
|
|
2599
|
+
* and returns its index if found or -1 otherwise.
|
|
2600
|
+
*
|
|
2601
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
2602
|
+
*/
|
|
2603
|
+
indexOfCategoryRegion(
|
|
2604
|
+
/**
|
|
2605
|
+
* The categoryRegion whose index is looked for
|
|
2606
|
+
*/
|
|
2607
|
+
oCategoryRegion: Category
|
|
2608
|
+
): int;
|
|
2609
|
+
/**
|
|
2610
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2611
|
+
* will not be supported anymore from 1.38.
|
|
2612
|
+
*
|
|
2613
|
+
* Checks for the provided `sap.makit.Layer` in the aggregation {@link #getLayers layers}. and returns its
|
|
2614
|
+
* index if found or -1 otherwise.
|
|
2615
|
+
*
|
|
2616
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
2617
|
+
*/
|
|
2618
|
+
indexOfLayer(
|
|
2619
|
+
/**
|
|
2620
|
+
* The layer whose index is looked for
|
|
2621
|
+
*/
|
|
2622
|
+
oLayer: Layer
|
|
2623
|
+
): int;
|
|
2624
|
+
/**
|
|
2625
|
+
* Sets a new value for property {@link #getHeight height}.
|
|
2626
|
+
*
|
|
2627
|
+
* The height of the Chart
|
|
2628
|
+
*
|
|
2629
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2630
|
+
*
|
|
2631
|
+
* Default value is `'100%'`.
|
|
2632
|
+
*
|
|
2633
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2634
|
+
*/
|
|
2635
|
+
setHeight(
|
|
2636
|
+
/**
|
|
2637
|
+
* New value for property `height`
|
|
2638
|
+
*/
|
|
2639
|
+
sHeight?: CSSSize
|
|
2640
|
+
): this;
|
|
2641
|
+
/**
|
|
2642
|
+
* Sets a new value for property {@link #getLegendPosition legendPosition}.
|
|
2643
|
+
*
|
|
2644
|
+
* Legend position for Pie /Donut chart only.
|
|
2645
|
+
*
|
|
2646
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2647
|
+
*
|
|
2648
|
+
* Default value is `Left`.
|
|
2649
|
+
*
|
|
2650
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2651
|
+
*/
|
|
2652
|
+
setLegendPosition(
|
|
2653
|
+
/**
|
|
2654
|
+
* New value for property `legendPosition`
|
|
2655
|
+
*/
|
|
2656
|
+
sLegendPosition?: LegendPosition | keyof typeof LegendPosition
|
|
2657
|
+
): this;
|
|
2658
|
+
/**
|
|
2659
|
+
* Sets a new value for property {@link #getNumberOfVisibleCategories numberOfVisibleCategories}.
|
|
2660
|
+
*
|
|
2661
|
+
* The number of categories that will be visible on the chart at any time. The minimum value is 2. If not
|
|
2662
|
+
* set, the number of visible categories will be automatically adjusted depending on the screen size
|
|
2663
|
+
*
|
|
2664
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2665
|
+
*
|
|
2666
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2667
|
+
*/
|
|
2668
|
+
setNumberOfVisibleCategories(
|
|
2669
|
+
/**
|
|
2670
|
+
* New value for property `numberOfVisibleCategories`
|
|
2671
|
+
*/
|
|
2672
|
+
iNumberOfVisibleCategories?: int
|
|
2673
|
+
): this;
|
|
2674
|
+
/**
|
|
2675
|
+
* Sets a new value for property {@link #getPrimaryColorPalette primaryColorPalette}.
|
|
2676
|
+
*
|
|
2677
|
+
* Allow a combination chart’s primary axis color palette to be modified without affecting other charts'
|
|
2678
|
+
* color palette. If not set, the chart will use the default color palette defined in the theme. Accept
|
|
2679
|
+
* an array of color in string format or hex format. e.g. 0xff0000 "red" "rgb(255,0,0)"
|
|
2680
|
+
*
|
|
2681
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2682
|
+
*
|
|
2683
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2684
|
+
*/
|
|
2685
|
+
setPrimaryColorPalette(
|
|
2686
|
+
/**
|
|
2687
|
+
* New value for property `primaryColorPalette`
|
|
2688
|
+
*/
|
|
2689
|
+
oPrimaryColorPalette?: any
|
|
2690
|
+
): this;
|
|
2691
|
+
/**
|
|
2692
|
+
* Sets a new value for property {@link #getRangeSelectorStartPosition rangeSelectorStartPosition}.
|
|
2693
|
+
*
|
|
2694
|
+
* Specify the range selector start position, default value is 0.
|
|
2695
|
+
*
|
|
2696
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2697
|
+
*
|
|
2698
|
+
* Default value is `0`.
|
|
2699
|
+
*
|
|
2700
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2701
|
+
*/
|
|
2702
|
+
setRangeSelectorStartPosition(
|
|
2703
|
+
/**
|
|
2704
|
+
* New value for property `rangeSelectorStartPosition`
|
|
2705
|
+
*/
|
|
2706
|
+
iRangeSelectorStartPosition?: int
|
|
2707
|
+
): this;
|
|
2708
|
+
/**
|
|
2709
|
+
* Sets a new value for property {@link #getSecondaryColorPalette secondaryColorPalette}.
|
|
2710
|
+
*
|
|
2711
|
+
* Allow a combination chart’s secondary axis color palette to be modified without affecting other charts'
|
|
2712
|
+
* color palette. If not set, the chart will use the default color palette defined in the theme. Accept
|
|
2713
|
+
* an array of color in string format or hex format. e.g. 0xff0000 "red" "rgb(255,0,0)"
|
|
2714
|
+
*
|
|
2715
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2716
|
+
*
|
|
2717
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2718
|
+
*/
|
|
2719
|
+
setSecondaryColorPalette(
|
|
2720
|
+
/**
|
|
2721
|
+
* New value for property `secondaryColorPalette`
|
|
2722
|
+
*/
|
|
2723
|
+
oSecondaryColorPalette?: any
|
|
2724
|
+
): this;
|
|
2725
|
+
/**
|
|
2726
|
+
* Sets a new value for property {@link #getShowRangeSelector showRangeSelector}.
|
|
2727
|
+
*
|
|
2728
|
+
* Specify whether the range selector should be visible.
|
|
2729
|
+
*
|
|
2730
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2731
|
+
*
|
|
2732
|
+
* Default value is `true`.
|
|
2733
|
+
*
|
|
2734
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2735
|
+
*/
|
|
2736
|
+
setShowRangeSelector(
|
|
2737
|
+
/**
|
|
2738
|
+
* New value for property `showRangeSelector`
|
|
2739
|
+
*/
|
|
2740
|
+
bShowRangeSelector?: boolean
|
|
2741
|
+
): this;
|
|
2742
|
+
/**
|
|
2743
|
+
* Sets a new value for property {@link #getShowTableValue showTableValue}.
|
|
2744
|
+
*
|
|
2745
|
+
* Toggle to display the table value on a Bar chart. Only applies to Bar chart.
|
|
2746
|
+
*
|
|
2747
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2748
|
+
*
|
|
2749
|
+
* Default value is `true`.
|
|
2750
|
+
*
|
|
2751
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2752
|
+
*/
|
|
2753
|
+
setShowTableValue(
|
|
2754
|
+
/**
|
|
2755
|
+
* New value for property `showTableValue`
|
|
2756
|
+
*/
|
|
2757
|
+
bShowTableValue?: boolean
|
|
2758
|
+
): this;
|
|
2759
|
+
/**
|
|
2760
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
2761
|
+
*
|
|
2762
|
+
* The width of the Chart
|
|
2763
|
+
*
|
|
2764
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2765
|
+
*
|
|
2766
|
+
* Default value is `'100%'`.
|
|
2767
|
+
*
|
|
2768
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2769
|
+
*/
|
|
2770
|
+
setWidth(
|
|
2771
|
+
/**
|
|
2772
|
+
* New value for property `width`
|
|
2773
|
+
*/
|
|
2774
|
+
sWidth?: CSSSize
|
|
2775
|
+
): this;
|
|
2776
|
+
}
|
|
2777
|
+
|
|
2778
|
+
export interface $CombinationChartSettings extends $ControlSettings {
|
|
2779
|
+
/**
|
|
2780
|
+
* The width of the Chart
|
|
2781
|
+
*/
|
|
2782
|
+
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
2783
|
+
|
|
2784
|
+
/**
|
|
2785
|
+
* The height of the Chart
|
|
2786
|
+
*/
|
|
2787
|
+
height?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
2788
|
+
|
|
2789
|
+
/**
|
|
2790
|
+
* Specify whether the range selector should be visible.
|
|
2791
|
+
*/
|
|
2792
|
+
showRangeSelector?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
2793
|
+
|
|
2794
|
+
/**
|
|
2795
|
+
* Legend position for Pie /Donut chart only.
|
|
2796
|
+
*/
|
|
2797
|
+
legendPosition?:
|
|
2798
|
+
| (LegendPosition | keyof typeof LegendPosition)
|
|
2799
|
+
| PropertyBindingInfo
|
|
2800
|
+
| `{${string}}`;
|
|
2801
|
+
|
|
2802
|
+
/**
|
|
2803
|
+
* Allow a combination chart’s primary axis color palette to be modified without affecting other charts'
|
|
2804
|
+
* color palette. If not set, the chart will use the default color palette defined in the theme. Accept
|
|
2805
|
+
* an array of color in string format or hex format. e.g. 0xff0000 "red" "rgb(255,0,0)"
|
|
2806
|
+
*/
|
|
2807
|
+
primaryColorPalette?: any | PropertyBindingInfo | `{${string}}`;
|
|
2808
|
+
|
|
2809
|
+
/**
|
|
2810
|
+
* Allow a combination chart’s secondary axis color palette to be modified without affecting other charts'
|
|
2811
|
+
* color palette. If not set, the chart will use the default color palette defined in the theme. Accept
|
|
2812
|
+
* an array of color in string format or hex format. e.g. 0xff0000 "red" "rgb(255,0,0)"
|
|
2813
|
+
*/
|
|
2814
|
+
secondaryColorPalette?: any | PropertyBindingInfo | `{${string}}`;
|
|
2815
|
+
|
|
2816
|
+
/**
|
|
2817
|
+
* Toggle to display the table value on a Bar chart. Only applies to Bar chart.
|
|
2818
|
+
*/
|
|
2819
|
+
showTableValue?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
2820
|
+
|
|
2821
|
+
/**
|
|
2822
|
+
* The number of categories that will be visible on the chart at any time. The minimum value is 2. If not
|
|
2823
|
+
* set, the number of visible categories will be automatically adjusted depending on the screen size
|
|
2824
|
+
*/
|
|
2825
|
+
numberOfVisibleCategories?: int | PropertyBindingInfo | `{${string}}`;
|
|
2826
|
+
|
|
2827
|
+
/**
|
|
2828
|
+
* Specify the range selector start position, default value is 0.
|
|
2829
|
+
*/
|
|
2830
|
+
rangeSelectorStartPosition?: int | PropertyBindingInfo | `{${string}}`;
|
|
2831
|
+
|
|
2832
|
+
/**
|
|
2833
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2834
|
+
* will not be supported anymore from 1.38.
|
|
2835
|
+
*
|
|
2836
|
+
* Data region property of the chart's Categories
|
|
2837
|
+
*/
|
|
2838
|
+
categoryRegions?:
|
|
2839
|
+
| Category[]
|
|
2840
|
+
| Category
|
|
2841
|
+
| AggregationBindingInfo
|
|
2842
|
+
| `{${string}}`;
|
|
2843
|
+
|
|
2844
|
+
/**
|
|
2845
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2846
|
+
* will not be supported anymore from 1.38.
|
|
2847
|
+
*
|
|
2848
|
+
* The collection of charts
|
|
2849
|
+
*/
|
|
2850
|
+
layers?: Layer[] | Layer | AggregationBindingInfo | `{${string}}`;
|
|
2851
|
+
|
|
2852
|
+
/**
|
|
2853
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2854
|
+
* will not be supported anymore from 1.38.
|
|
2855
|
+
*
|
|
2856
|
+
* Category Axis property of the Chart. Accepts only an instance of CategoryAxis element.
|
|
2857
|
+
*/
|
|
2858
|
+
categoryAxis?: CategoryAxis;
|
|
2859
|
+
|
|
2860
|
+
/**
|
|
2861
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2862
|
+
* will not be supported anymore from 1.38.
|
|
2863
|
+
*
|
|
2864
|
+
* Property of the Combination Chart's primary Value Axis. Accept only an instance of ValueAxis element.
|
|
2865
|
+
*/
|
|
2866
|
+
primaryValueAxis?: ValueAxis;
|
|
2867
|
+
|
|
2868
|
+
/**
|
|
2869
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2870
|
+
* will not be supported anymore from 1.38.
|
|
2871
|
+
*
|
|
2872
|
+
* Property of the Combination Chart's secondary Value Axis. Accept only an instance of ValueAxis element.
|
|
2873
|
+
*/
|
|
2874
|
+
secondaryValueAxis?: ValueAxis;
|
|
2875
|
+
|
|
2876
|
+
/**
|
|
2877
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2878
|
+
* will not be supported anymore from 1.38.
|
|
2879
|
+
*
|
|
2880
|
+
* Value Bubble property of the Chart. Accept only an instance of ValueBubble element.
|
|
2881
|
+
*/
|
|
2882
|
+
valueBubble?: ValueBubble;
|
|
2883
|
+
|
|
2884
|
+
/**
|
|
2885
|
+
* Double tap event on the chart
|
|
2886
|
+
*/
|
|
2887
|
+
doubletap?: (oEvent: Event) => void;
|
|
2888
|
+
|
|
2889
|
+
/**
|
|
2890
|
+
* Single tap event on the chart
|
|
2891
|
+
*/
|
|
2892
|
+
tap?: (oEvent: Event) => void;
|
|
2893
|
+
|
|
2894
|
+
/**
|
|
2895
|
+
* Long press event on the chart
|
|
2896
|
+
*/
|
|
2897
|
+
longpress?: (oEvent: Event) => void;
|
|
2898
|
+
}
|
|
2899
|
+
}
|
|
2900
|
+
|
|
2901
|
+
declare module "sap/makit/Layer" {
|
|
2902
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
2903
|
+
|
|
2904
|
+
import Column from "sap/makit/Column";
|
|
2905
|
+
|
|
2906
|
+
import {
|
|
2907
|
+
AggregationBindingInfo,
|
|
2908
|
+
PropertyBindingInfo,
|
|
2909
|
+
} from "sap/ui/base/ManagedObject";
|
|
2910
|
+
|
|
2911
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
2912
|
+
|
|
2913
|
+
import Row from "sap/makit/Row";
|
|
2914
|
+
|
|
2915
|
+
import Series from "sap/makit/Series";
|
|
2916
|
+
|
|
2917
|
+
import { ChartType } from "sap/makit/library";
|
|
2918
|
+
|
|
2919
|
+
import Value from "sap/makit/Value";
|
|
2920
|
+
|
|
2921
|
+
/**
|
|
2922
|
+
* @SINCE 1.12
|
|
2923
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
2924
|
+
* will not be supported anymore from 1.38.
|
|
2925
|
+
*
|
|
2926
|
+
* Layer represent a chart in the CombinationChart
|
|
2927
|
+
*/
|
|
2928
|
+
export default class Layer extends UI5Element {
|
|
2929
|
+
/**
|
|
2930
|
+
* Constructor for a new Layer.
|
|
2931
|
+
*
|
|
2932
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2933
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2934
|
+
* of the syntax of the settings object.
|
|
2935
|
+
*/
|
|
2936
|
+
constructor(
|
|
2937
|
+
/**
|
|
2938
|
+
* initial settings for the new control
|
|
2939
|
+
*/
|
|
2940
|
+
mSettings?: $LayerSettings
|
|
2941
|
+
);
|
|
2942
|
+
/**
|
|
2943
|
+
* Constructor for a new Layer.
|
|
2944
|
+
*
|
|
2945
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2946
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
2947
|
+
* of the syntax of the settings object.
|
|
2948
|
+
*/
|
|
2949
|
+
constructor(
|
|
2950
|
+
/**
|
|
2951
|
+
* id for the new control, generated automatically if no id is given
|
|
2952
|
+
*/
|
|
2953
|
+
sId?: string,
|
|
2954
|
+
/**
|
|
2955
|
+
* initial settings for the new control
|
|
2956
|
+
*/
|
|
2957
|
+
mSettings?: $LayerSettings
|
|
2958
|
+
);
|
|
2959
|
+
|
|
2960
|
+
/**
|
|
2961
|
+
* Creates a new subclass of class sap.makit.Layer with name `sClassName` and enriches it with the information
|
|
2962
|
+
* contained in `oClassInfo`.
|
|
2963
|
+
*
|
|
2964
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
2965
|
+
*
|
|
2966
|
+
* @returns Created class / constructor function
|
|
2967
|
+
*/
|
|
2968
|
+
static extend<T extends Record<string, unknown>>(
|
|
2969
|
+
/**
|
|
2970
|
+
* Name of the class being created
|
|
2971
|
+
*/
|
|
2972
|
+
sClassName: string,
|
|
2973
|
+
/**
|
|
2974
|
+
* Object literal with information about the class
|
|
2975
|
+
*/
|
|
2976
|
+
oClassInfo?: sap.ClassInfo<T, Layer>,
|
|
2977
|
+
/**
|
|
2978
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2979
|
+
* used by this class
|
|
2980
|
+
*/
|
|
2981
|
+
FNMetaImpl?: Function
|
|
2982
|
+
): Function;
|
|
2983
|
+
/**
|
|
2984
|
+
* Returns a metadata object for class sap.makit.Layer.
|
|
2985
|
+
*
|
|
2986
|
+
* @returns Metadata object describing this class
|
|
2987
|
+
*/
|
|
2988
|
+
static getMetadata(): ElementMetadata;
|
|
2989
|
+
/**
|
|
2990
|
+
* Adds some column to the aggregation {@link #getColumns columns}.
|
|
2991
|
+
*
|
|
2992
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2993
|
+
*/
|
|
2994
|
+
addColumn(
|
|
2995
|
+
/**
|
|
2996
|
+
* The column to add; if empty, nothing is inserted
|
|
2997
|
+
*/
|
|
2998
|
+
oColumn: Column
|
|
2999
|
+
): this;
|
|
3000
|
+
/**
|
|
3001
|
+
* Binds aggregation {@link #getColumns columns} to model data.
|
|
3002
|
+
*
|
|
3003
|
+
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
|
|
3004
|
+
* of the possible properties of `oBindingInfo`.
|
|
3005
|
+
*
|
|
3006
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3007
|
+
*/
|
|
3008
|
+
bindColumns(
|
|
3009
|
+
/**
|
|
3010
|
+
* The binding information
|
|
3011
|
+
*/
|
|
3012
|
+
oBindingInfo: AggregationBindingInfo
|
|
3013
|
+
): this;
|
|
3014
|
+
/**
|
|
3015
|
+
* Binds aggregation {@link #getRows rows} to model data.
|
|
3016
|
+
*
|
|
3017
|
+
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
|
|
3018
|
+
* of the possible properties of `oBindingInfo`.
|
|
3019
|
+
*
|
|
3020
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3021
|
+
*/
|
|
3022
|
+
bindRows(
|
|
3023
|
+
/**
|
|
3024
|
+
* The binding information
|
|
3025
|
+
*/
|
|
3026
|
+
oBindingInfo: AggregationBindingInfo
|
|
3027
|
+
): this;
|
|
3028
|
+
/**
|
|
3029
|
+
* Destroys all the columns in the aggregation {@link #getColumns columns}.
|
|
3030
|
+
*
|
|
3031
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3032
|
+
*/
|
|
3033
|
+
destroyColumns(): this;
|
|
3034
|
+
/**
|
|
3035
|
+
* Destroys the series in the aggregation {@link #getSeries series}.
|
|
3036
|
+
*
|
|
3037
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3038
|
+
*/
|
|
3039
|
+
destroySeries(): this;
|
|
3040
|
+
/**
|
|
3041
|
+
* Destroys all the values in the aggregation {@link #getValues values}.
|
|
3042
|
+
*
|
|
3043
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3044
|
+
*/
|
|
3045
|
+
destroyValues(): this;
|
|
3046
|
+
/**
|
|
3047
|
+
* Gets content of aggregation {@link #getColumns columns}.
|
|
3048
|
+
*
|
|
3049
|
+
* The data column map of the chart.
|
|
3050
|
+
*/
|
|
3051
|
+
getColumns(): Column[];
|
|
3052
|
+
/**
|
|
3053
|
+
* Gets current value of property {@link #getDrawOnSecondaryAxis drawOnSecondaryAxis}.
|
|
3054
|
+
*
|
|
3055
|
+
* Specifiy whether this layer should be drawn on the secondary axis.
|
|
3056
|
+
*
|
|
3057
|
+
* Default value is `false`.
|
|
3058
|
+
*
|
|
3059
|
+
* @returns Value of property `drawOnSecondaryAxis`
|
|
3060
|
+
*/
|
|
3061
|
+
getDrawOnSecondaryAxis(): boolean;
|
|
3062
|
+
/**
|
|
3063
|
+
* Gets current value of property {@link #getLineThickness lineThickness}.
|
|
3064
|
+
*
|
|
3065
|
+
* Specify the line thickness of the line graph. Only applies to Line chart type.
|
|
3066
|
+
*
|
|
3067
|
+
* Default value is `1`.
|
|
3068
|
+
*
|
|
3069
|
+
* @returns Value of property `lineThickness`
|
|
3070
|
+
*/
|
|
3071
|
+
getLineThickness(): float;
|
|
3072
|
+
/**
|
|
3073
|
+
* Gets current value of property {@link #getPrimaryColorPalette primaryColorPalette}.
|
|
3074
|
+
*
|
|
3075
|
+
* Allow a layer’s primary axis color palette to be modified without affecting other charts in the same
|
|
3076
|
+
* screen. If not set, the chart will use the default color palette defined in the theme. This property
|
|
3077
|
+
* will take precedence over other CombinationChart's color palette properties. Accept an array of color
|
|
3078
|
+
* in string format or hex format. e.g. 0xff0000 "red" "rgb(255,0,0)"
|
|
3079
|
+
*
|
|
3080
|
+
* @returns Value of property `primaryColorPalette`
|
|
3081
|
+
*/
|
|
3082
|
+
getPrimaryColorPalette(): any;
|
|
3083
|
+
/**
|
|
3084
|
+
* Gets content of aggregation {@link #getRows rows}.
|
|
3085
|
+
*
|
|
3086
|
+
* The data rows of the chart. User should bind these to their data source
|
|
3087
|
+
*/
|
|
3088
|
+
getRows(): Row[];
|
|
3089
|
+
/**
|
|
3090
|
+
* Get the value of the currently highlighted series
|
|
3091
|
+
*/
|
|
3092
|
+
getSelectedSeries(): string;
|
|
3093
|
+
/**
|
|
3094
|
+
* Gets content of aggregation {@link #getSeries series}.
|
|
3095
|
+
*
|
|
3096
|
+
* Data region property of the chart's Series
|
|
3097
|
+
*/
|
|
3098
|
+
getSeries(): Series;
|
|
3099
|
+
/**
|
|
3100
|
+
* Gets current value of property {@link #getType type}.
|
|
3101
|
+
*
|
|
3102
|
+
* Chart type
|
|
3103
|
+
*
|
|
3104
|
+
* Default value is `Column`.
|
|
3105
|
+
*
|
|
3106
|
+
* @returns Value of property `type`
|
|
3107
|
+
*/
|
|
3108
|
+
getType(): ChartType | keyof typeof ChartType;
|
|
3109
|
+
/**
|
|
3110
|
+
* Gets content of aggregation {@link #getValues values}.
|
|
3111
|
+
*
|
|
3112
|
+
* Data region property of the chart's Values
|
|
3113
|
+
*/
|
|
3114
|
+
getValues(): Value[];
|
|
3115
|
+
/**
|
|
3116
|
+
* Checks for the provided `sap.makit.Column` in the aggregation {@link #getColumns columns}. and returns
|
|
3117
|
+
* its index if found or -1 otherwise.
|
|
3118
|
+
*
|
|
3119
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
3120
|
+
*/
|
|
3121
|
+
indexOfColumn(
|
|
3122
|
+
/**
|
|
3123
|
+
* The column whose index is looked for
|
|
3124
|
+
*/
|
|
3125
|
+
oColumn: Column
|
|
3126
|
+
): int;
|
|
3127
|
+
/**
|
|
3128
|
+
* Checks for the provided `sap.makit.Row` in the aggregation {@link #getRows rows}. and returns its index
|
|
3129
|
+
* if found or -1 otherwise.
|
|
3130
|
+
*
|
|
3131
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
3132
|
+
*/
|
|
3133
|
+
indexOfRow(
|
|
3134
|
+
/**
|
|
3135
|
+
* The row whose index is looked for
|
|
3136
|
+
*/
|
|
3137
|
+
oRow: Row
|
|
3138
|
+
): int;
|
|
3139
|
+
/**
|
|
3140
|
+
* Checks for the provided `sap.makit.Value` in the aggregation {@link #getValues values}. and returns its
|
|
3141
|
+
* index if found or -1 otherwise.
|
|
3142
|
+
*
|
|
3143
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
3144
|
+
*/
|
|
3145
|
+
indexOfValue(
|
|
3146
|
+
/**
|
|
3147
|
+
* The value whose index is looked for
|
|
3148
|
+
*/
|
|
3149
|
+
oValue: Value
|
|
3150
|
+
): int;
|
|
3151
|
+
/**
|
|
3152
|
+
* Inserts a column into the aggregation {@link #getColumns columns}.
|
|
3153
|
+
*
|
|
3154
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3155
|
+
*/
|
|
3156
|
+
insertColumn(
|
|
3157
|
+
/**
|
|
3158
|
+
* The column to insert; if empty, nothing is inserted
|
|
3159
|
+
*/
|
|
3160
|
+
oColumn: Column,
|
|
3161
|
+
/**
|
|
3162
|
+
* The `0`-based index the column should be inserted at; for a negative value of `iIndex`, the column is
|
|
3163
|
+
* inserted at position 0; for a value greater than the current size of the aggregation, the column is inserted
|
|
3164
|
+
* at the last position
|
|
3165
|
+
*/
|
|
3166
|
+
iIndex: int
|
|
3167
|
+
): this;
|
|
3168
|
+
/**
|
|
3169
|
+
* Inserts a value into the aggregation {@link #getValues values}.
|
|
3170
|
+
*
|
|
3171
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3172
|
+
*/
|
|
3173
|
+
insertValue(
|
|
3174
|
+
/**
|
|
3175
|
+
* The value to insert; if empty, nothing is inserted
|
|
3176
|
+
*/
|
|
3177
|
+
oValue: Value,
|
|
3178
|
+
/**
|
|
3179
|
+
* The `0`-based index the value should be inserted at; for a negative value of `iIndex`, the value is inserted
|
|
3180
|
+
* at position 0; for a value greater than the current size of the aggregation, the value is inserted at
|
|
3181
|
+
* the last position
|
|
3182
|
+
*/
|
|
3183
|
+
iIndex: int
|
|
3184
|
+
): this;
|
|
3185
|
+
/**
|
|
3186
|
+
* Removes all the controls from the aggregation {@link #getColumns columns}.
|
|
3187
|
+
*
|
|
3188
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
3189
|
+
*
|
|
3190
|
+
* @returns An array of the removed elements (might be empty)
|
|
3191
|
+
*/
|
|
3192
|
+
removeAllColumns(): Column[];
|
|
3193
|
+
/**
|
|
3194
|
+
* Removes all the controls from the aggregation {@link #getValues values}.
|
|
3195
|
+
*
|
|
3196
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
3197
|
+
*
|
|
3198
|
+
* @returns An array of the removed elements (might be empty)
|
|
3199
|
+
*/
|
|
3200
|
+
removeAllValues(): Value[];
|
|
3201
|
+
/**
|
|
3202
|
+
* Removes a column from the aggregation {@link #getColumns columns}.
|
|
3203
|
+
*
|
|
3204
|
+
* @returns The removed column or `null`
|
|
3205
|
+
*/
|
|
3206
|
+
removeColumn(
|
|
3207
|
+
/**
|
|
3208
|
+
* The column to remove or its index or id
|
|
3209
|
+
*/
|
|
3210
|
+
vColumn: int | string | Column
|
|
3211
|
+
): Column | null;
|
|
3212
|
+
/**
|
|
3213
|
+
* Removes a value from the aggregation {@link #getValues values}.
|
|
3214
|
+
*
|
|
3215
|
+
* @returns The removed value or `null`
|
|
3216
|
+
*/
|
|
3217
|
+
removeValue(
|
|
3218
|
+
/**
|
|
3219
|
+
* The value to remove or its index or id
|
|
3220
|
+
*/
|
|
3221
|
+
vValue: int | string | Value
|
|
3222
|
+
): Value | null;
|
|
3223
|
+
/**
|
|
3224
|
+
* Sets a new value for property {@link #getDrawOnSecondaryAxis drawOnSecondaryAxis}.
|
|
3225
|
+
*
|
|
3226
|
+
* Specifiy whether this layer should be drawn on the secondary axis.
|
|
3227
|
+
*
|
|
3228
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3229
|
+
*
|
|
3230
|
+
* Default value is `false`.
|
|
3231
|
+
*
|
|
3232
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3233
|
+
*/
|
|
3234
|
+
setDrawOnSecondaryAxis(
|
|
3235
|
+
/**
|
|
3236
|
+
* New value for property `drawOnSecondaryAxis`
|
|
3237
|
+
*/
|
|
3238
|
+
bDrawOnSecondaryAxis?: boolean
|
|
3239
|
+
): this;
|
|
3240
|
+
/**
|
|
3241
|
+
* Sets a new value for property {@link #getLineThickness lineThickness}.
|
|
3242
|
+
*
|
|
3243
|
+
* Specify the line thickness of the line graph. Only applies to Line chart type.
|
|
3244
|
+
*
|
|
3245
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3246
|
+
*
|
|
3247
|
+
* Default value is `1`.
|
|
3248
|
+
*
|
|
3249
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3250
|
+
*/
|
|
3251
|
+
setLineThickness(
|
|
3252
|
+
/**
|
|
3253
|
+
* New value for property `lineThickness`
|
|
3254
|
+
*/
|
|
3255
|
+
fLineThickness?: float
|
|
3256
|
+
): this;
|
|
3257
|
+
/**
|
|
3258
|
+
* Sets a new value for property {@link #getPrimaryColorPalette primaryColorPalette}.
|
|
3259
|
+
*
|
|
3260
|
+
* Allow a layer’s primary axis color palette to be modified without affecting other charts in the same
|
|
3261
|
+
* screen. If not set, the chart will use the default color palette defined in the theme. This property
|
|
3262
|
+
* will take precedence over other CombinationChart's color palette properties. Accept an array of color
|
|
3263
|
+
* in string format or hex format. e.g. 0xff0000 "red" "rgb(255,0,0)"
|
|
3264
|
+
*
|
|
3265
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3266
|
+
*
|
|
3267
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3268
|
+
*/
|
|
3269
|
+
setPrimaryColorPalette(
|
|
3270
|
+
/**
|
|
3271
|
+
* New value for property `primaryColorPalette`
|
|
3272
|
+
*/
|
|
3273
|
+
oPrimaryColorPalette?: any
|
|
3274
|
+
): this;
|
|
3275
|
+
/**
|
|
3276
|
+
* Sets a new value for property {@link #getType type}.
|
|
3277
|
+
*
|
|
3278
|
+
* Chart type
|
|
3279
|
+
*
|
|
3280
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3281
|
+
*
|
|
3282
|
+
* Default value is `Column`.
|
|
3283
|
+
*
|
|
3284
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3285
|
+
*/
|
|
3286
|
+
setType(
|
|
3287
|
+
/**
|
|
3288
|
+
* New value for property `type`
|
|
3289
|
+
*/
|
|
3290
|
+
sType?: ChartType | keyof typeof ChartType
|
|
3291
|
+
): this;
|
|
3292
|
+
/**
|
|
3293
|
+
* Unbinds aggregation {@link #getColumns columns} from model data.
|
|
3294
|
+
*
|
|
3295
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3296
|
+
*/
|
|
3297
|
+
unbindColumns(): this;
|
|
3298
|
+
/**
|
|
3299
|
+
* Unbinds aggregation {@link #getRows rows} from model data.
|
|
3300
|
+
*
|
|
3301
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3302
|
+
*/
|
|
3303
|
+
unbindRows(): this;
|
|
3304
|
+
}
|
|
3305
|
+
|
|
3306
|
+
export interface $LayerSettings extends $ElementSettings {
|
|
3307
|
+
/**
|
|
3308
|
+
* Chart type
|
|
3309
|
+
*/
|
|
3310
|
+
type?:
|
|
3311
|
+
| (ChartType | keyof typeof ChartType)
|
|
3312
|
+
| PropertyBindingInfo
|
|
3313
|
+
| `{${string}}`;
|
|
3314
|
+
|
|
3315
|
+
/**
|
|
3316
|
+
* Specify the line thickness of the line graph. Only applies to Line chart type.
|
|
3317
|
+
*/
|
|
3318
|
+
lineThickness?: float | PropertyBindingInfo | `{${string}}`;
|
|
3319
|
+
|
|
3320
|
+
/**
|
|
3321
|
+
* Allow a layer’s primary axis color palette to be modified without affecting other charts in the same
|
|
3322
|
+
* screen. If not set, the chart will use the default color palette defined in the theme. This property
|
|
3323
|
+
* will take precedence over other CombinationChart's color palette properties. Accept an array of color
|
|
3324
|
+
* in string format or hex format. e.g. 0xff0000 "red" "rgb(255,0,0)"
|
|
3325
|
+
*/
|
|
3326
|
+
primaryColorPalette?: any | PropertyBindingInfo | `{${string}}`;
|
|
3327
|
+
|
|
3328
|
+
/**
|
|
3329
|
+
* Specifiy whether this layer should be drawn on the secondary axis.
|
|
3330
|
+
*/
|
|
3331
|
+
drawOnSecondaryAxis?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
3332
|
+
|
|
3333
|
+
/**
|
|
3334
|
+
* The data rows of the chart. User should bind these to their data source
|
|
3335
|
+
*/
|
|
3336
|
+
rows?: Row[] | Row | AggregationBindingInfo | `{${string}}`;
|
|
3337
|
+
|
|
3338
|
+
/**
|
|
3339
|
+
* The data column map of the chart.
|
|
3340
|
+
*/
|
|
3341
|
+
columns?: Column[] | Column | AggregationBindingInfo | `{${string}}`;
|
|
3342
|
+
|
|
3343
|
+
/**
|
|
3344
|
+
* Data region property of the chart's Series
|
|
3345
|
+
*/
|
|
3346
|
+
series?: Series;
|
|
3347
|
+
|
|
3348
|
+
/**
|
|
3349
|
+
* Data region property of the chart's Values
|
|
3350
|
+
*/
|
|
3351
|
+
values?: Value[] | Value | AggregationBindingInfo | `{${string}}`;
|
|
3352
|
+
}
|
|
3353
|
+
}
|
|
3354
|
+
|
|
3355
|
+
declare module "sap/makit/MakitLib" {
|
|
3356
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
3357
|
+
|
|
3358
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
3359
|
+
|
|
3360
|
+
/**
|
|
3361
|
+
* @SINCE 1.12
|
|
3362
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
3363
|
+
* will not be supported anymore from 1.38.
|
|
3364
|
+
*
|
|
3365
|
+
* Wrapper for MAKit Chart Library. Only to be used used internally.
|
|
3366
|
+
*/
|
|
3367
|
+
export default class MakitLib extends UI5Element {
|
|
3368
|
+
/**
|
|
3369
|
+
* Constructor for a new MakitLib.
|
|
3370
|
+
*
|
|
3371
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3372
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3373
|
+
* of the syntax of the settings object.
|
|
3374
|
+
*
|
|
3375
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Element#constructor
|
|
3376
|
+
* sap.ui.core.Element} can be used.
|
|
3377
|
+
*/
|
|
3378
|
+
constructor(
|
|
3379
|
+
/**
|
|
3380
|
+
* initial settings for the new control
|
|
3381
|
+
*/
|
|
3382
|
+
mSettings?: $MakitLibSettings
|
|
3383
|
+
);
|
|
3384
|
+
/**
|
|
3385
|
+
* Constructor for a new MakitLib.
|
|
3386
|
+
*
|
|
3387
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3388
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3389
|
+
* of the syntax of the settings object.
|
|
3390
|
+
*
|
|
3391
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Element#constructor
|
|
3392
|
+
* sap.ui.core.Element} can be used.
|
|
3393
|
+
*/
|
|
3394
|
+
constructor(
|
|
3395
|
+
/**
|
|
3396
|
+
* id for the new control, generated automatically if no id is given
|
|
3397
|
+
*/
|
|
3398
|
+
sId?: string,
|
|
3399
|
+
/**
|
|
3400
|
+
* initial settings for the new control
|
|
3401
|
+
*/
|
|
3402
|
+
mSettings?: $MakitLibSettings
|
|
3403
|
+
);
|
|
3404
|
+
|
|
3405
|
+
/**
|
|
3406
|
+
* Creates a new subclass of class sap.makit.MakitLib with name `sClassName` and enriches it with the information
|
|
3407
|
+
* contained in `oClassInfo`.
|
|
3408
|
+
*
|
|
3409
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
3410
|
+
*
|
|
3411
|
+
* @returns Created class / constructor function
|
|
3412
|
+
*/
|
|
3413
|
+
static extend<T extends Record<string, unknown>>(
|
|
3414
|
+
/**
|
|
3415
|
+
* Name of the class being created
|
|
3416
|
+
*/
|
|
3417
|
+
sClassName: string,
|
|
3418
|
+
/**
|
|
3419
|
+
* Object literal with information about the class
|
|
3420
|
+
*/
|
|
3421
|
+
oClassInfo?: sap.ClassInfo<T, MakitLib>,
|
|
3422
|
+
/**
|
|
3423
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3424
|
+
* used by this class
|
|
3425
|
+
*/
|
|
3426
|
+
FNMetaImpl?: Function
|
|
3427
|
+
): Function;
|
|
3428
|
+
/**
|
|
3429
|
+
* Returns a metadata object for class sap.makit.MakitLib.
|
|
3430
|
+
*
|
|
3431
|
+
* @returns Metadata object describing this class
|
|
3432
|
+
*/
|
|
3433
|
+
static getMetadata(): ElementMetadata;
|
|
3434
|
+
}
|
|
3435
|
+
|
|
3436
|
+
export interface $MakitLibSettings extends $ElementSettings {}
|
|
3437
|
+
}
|
|
3438
|
+
|
|
3439
|
+
declare module "sap/makit/Row" {
|
|
3440
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
3441
|
+
|
|
3442
|
+
import Column from "sap/makit/Column";
|
|
3443
|
+
|
|
3444
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
3445
|
+
|
|
3446
|
+
import { AggregationBindingInfo } from "sap/ui/base/ManagedObject";
|
|
3447
|
+
|
|
3448
|
+
/**
|
|
3449
|
+
* @SINCE 1.8
|
|
3450
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
3451
|
+
* will not be supported anymore from 1.38.
|
|
3452
|
+
*
|
|
3453
|
+
* The data row of the Chart's data table
|
|
3454
|
+
*/
|
|
3455
|
+
export default class Row extends UI5Element {
|
|
3456
|
+
/**
|
|
3457
|
+
* Constructor for a new Row.
|
|
3458
|
+
*
|
|
3459
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3460
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3461
|
+
* of the syntax of the settings object.
|
|
3462
|
+
*/
|
|
3463
|
+
constructor(
|
|
3464
|
+
/**
|
|
3465
|
+
* initial settings for the new control
|
|
3466
|
+
*/
|
|
3467
|
+
mSettings?: $RowSettings
|
|
3468
|
+
);
|
|
3469
|
+
/**
|
|
3470
|
+
* Constructor for a new Row.
|
|
3471
|
+
*
|
|
3472
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3473
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3474
|
+
* of the syntax of the settings object.
|
|
3475
|
+
*/
|
|
3476
|
+
constructor(
|
|
3477
|
+
/**
|
|
3478
|
+
* id for the new control, generated automatically if no id is given
|
|
3479
|
+
*/
|
|
3480
|
+
sId?: string,
|
|
3481
|
+
/**
|
|
3482
|
+
* initial settings for the new control
|
|
3483
|
+
*/
|
|
3484
|
+
mSettings?: $RowSettings
|
|
3485
|
+
);
|
|
3486
|
+
|
|
3487
|
+
/**
|
|
3488
|
+
* Creates a new subclass of class sap.makit.Row with name `sClassName` and enriches it with the information
|
|
3489
|
+
* contained in `oClassInfo`.
|
|
3490
|
+
*
|
|
3491
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
3492
|
+
*
|
|
3493
|
+
* @returns Created class / constructor function
|
|
3494
|
+
*/
|
|
3495
|
+
static extend<T extends Record<string, unknown>>(
|
|
3496
|
+
/**
|
|
3497
|
+
* Name of the class being created
|
|
3498
|
+
*/
|
|
3499
|
+
sClassName: string,
|
|
3500
|
+
/**
|
|
3501
|
+
* Object literal with information about the class
|
|
3502
|
+
*/
|
|
3503
|
+
oClassInfo?: sap.ClassInfo<T, Row>,
|
|
3504
|
+
/**
|
|
3505
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3506
|
+
* used by this class
|
|
3507
|
+
*/
|
|
3508
|
+
FNMetaImpl?: Function
|
|
3509
|
+
): Function;
|
|
3510
|
+
/**
|
|
3511
|
+
* Returns a metadata object for class sap.makit.Row.
|
|
3512
|
+
*
|
|
3513
|
+
* @returns Metadata object describing this class
|
|
3514
|
+
*/
|
|
3515
|
+
static getMetadata(): ElementMetadata;
|
|
3516
|
+
/**
|
|
3517
|
+
* Adds some cell to the aggregation {@link #getCells cells}.
|
|
3518
|
+
*
|
|
3519
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3520
|
+
*/
|
|
3521
|
+
addCell(
|
|
3522
|
+
/**
|
|
3523
|
+
* The cell to add; if empty, nothing is inserted
|
|
3524
|
+
*/
|
|
3525
|
+
oCell: Column
|
|
3526
|
+
): this;
|
|
3527
|
+
/**
|
|
3528
|
+
* Destroys all the cells in the aggregation {@link #getCells cells}.
|
|
3529
|
+
*
|
|
3530
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3531
|
+
*/
|
|
3532
|
+
destroyCells(): this;
|
|
3533
|
+
/**
|
|
3534
|
+
* Gets content of aggregation {@link #getCells cells}.
|
|
3535
|
+
*
|
|
3536
|
+
* Representing the cells of the row. User should not add individual cells. The cells will be added automatically
|
|
3537
|
+
* via Column mapping.
|
|
3538
|
+
*/
|
|
3539
|
+
getCells(): Column[];
|
|
3540
|
+
/**
|
|
3541
|
+
* Checks for the provided `sap.makit.Column` in the aggregation {@link #getCells cells}. and returns its
|
|
3542
|
+
* index if found or -1 otherwise.
|
|
3543
|
+
*
|
|
3544
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
3545
|
+
*/
|
|
3546
|
+
indexOfCell(
|
|
3547
|
+
/**
|
|
3548
|
+
* The cell whose index is looked for
|
|
3549
|
+
*/
|
|
3550
|
+
oCell: Column
|
|
3551
|
+
): int;
|
|
3552
|
+
/**
|
|
3553
|
+
* Inserts a cell into the aggregation {@link #getCells cells}.
|
|
3554
|
+
*
|
|
3555
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3556
|
+
*/
|
|
3557
|
+
insertCell(
|
|
3558
|
+
/**
|
|
3559
|
+
* The cell to insert; if empty, nothing is inserted
|
|
3560
|
+
*/
|
|
3561
|
+
oCell: Column,
|
|
3562
|
+
/**
|
|
3563
|
+
* The `0`-based index the cell should be inserted at; for a negative value of `iIndex`, the cell is inserted
|
|
3564
|
+
* at position 0; for a value greater than the current size of the aggregation, the cell is inserted at
|
|
3565
|
+
* the last position
|
|
3566
|
+
*/
|
|
3567
|
+
iIndex: int
|
|
3568
|
+
): this;
|
|
3569
|
+
/**
|
|
3570
|
+
* Removes all the controls from the aggregation {@link #getCells cells}.
|
|
3571
|
+
*
|
|
3572
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
3573
|
+
*
|
|
3574
|
+
* @returns An array of the removed elements (might be empty)
|
|
3575
|
+
*/
|
|
3576
|
+
removeAllCells(): Column[];
|
|
3577
|
+
/**
|
|
3578
|
+
* Removes a cell from the aggregation {@link #getCells cells}.
|
|
3579
|
+
*
|
|
3580
|
+
* @returns The removed cell or `null`
|
|
3581
|
+
*/
|
|
3582
|
+
removeCell(
|
|
3583
|
+
/**
|
|
3584
|
+
* The cell to remove or its index or id
|
|
3585
|
+
*/
|
|
3586
|
+
vCell: int | string | Column
|
|
3587
|
+
): Column | null;
|
|
3588
|
+
}
|
|
3589
|
+
|
|
3590
|
+
export interface $RowSettings extends $ElementSettings {
|
|
3591
|
+
/**
|
|
3592
|
+
* Representing the cells of the row. User should not add individual cells. The cells will be added automatically
|
|
3593
|
+
* via Column mapping.
|
|
3594
|
+
*/
|
|
3595
|
+
cells?: Column[] | Column | AggregationBindingInfo | `{${string}}`;
|
|
3596
|
+
}
|
|
3597
|
+
}
|
|
3598
|
+
|
|
3599
|
+
declare module "sap/makit/Series" {
|
|
3600
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
3601
|
+
|
|
3602
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
3603
|
+
|
|
3604
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
3605
|
+
|
|
3606
|
+
/**
|
|
3607
|
+
* @SINCE 1.8
|
|
3608
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
3609
|
+
* will not be supported anymore from 1.38.
|
|
3610
|
+
*
|
|
3611
|
+
* Represents the Series data region of the Chart.
|
|
3612
|
+
*/
|
|
3613
|
+
export default class Series extends UI5Element {
|
|
3614
|
+
/**
|
|
3615
|
+
* Constructor for a new Series.
|
|
3616
|
+
*
|
|
3617
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3618
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3619
|
+
* of the syntax of the settings object.
|
|
3620
|
+
*/
|
|
3621
|
+
constructor(
|
|
3622
|
+
/**
|
|
3623
|
+
* initial settings for the new control
|
|
3624
|
+
*/
|
|
3625
|
+
mSettings?: $SeriesSettings
|
|
3626
|
+
);
|
|
3627
|
+
/**
|
|
3628
|
+
* Constructor for a new Series.
|
|
3629
|
+
*
|
|
3630
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3631
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3632
|
+
* of the syntax of the settings object.
|
|
3633
|
+
*/
|
|
3634
|
+
constructor(
|
|
3635
|
+
/**
|
|
3636
|
+
* id for the new control, generated automatically if no id is given
|
|
3637
|
+
*/
|
|
3638
|
+
sId?: string,
|
|
3639
|
+
/**
|
|
3640
|
+
* initial settings for the new control
|
|
3641
|
+
*/
|
|
3642
|
+
mSettings?: $SeriesSettings
|
|
3643
|
+
);
|
|
3644
|
+
|
|
3645
|
+
/**
|
|
3646
|
+
* Creates a new subclass of class sap.makit.Series with name `sClassName` and enriches it with the information
|
|
3647
|
+
* contained in `oClassInfo`.
|
|
3648
|
+
*
|
|
3649
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
3650
|
+
*
|
|
3651
|
+
* @returns Created class / constructor function
|
|
3652
|
+
*/
|
|
3653
|
+
static extend<T extends Record<string, unknown>>(
|
|
3654
|
+
/**
|
|
3655
|
+
* Name of the class being created
|
|
3656
|
+
*/
|
|
3657
|
+
sClassName: string,
|
|
3658
|
+
/**
|
|
3659
|
+
* Object literal with information about the class
|
|
3660
|
+
*/
|
|
3661
|
+
oClassInfo?: sap.ClassInfo<T, Series>,
|
|
3662
|
+
/**
|
|
3663
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3664
|
+
* used by this class
|
|
3665
|
+
*/
|
|
3666
|
+
FNMetaImpl?: Function
|
|
3667
|
+
): Function;
|
|
3668
|
+
/**
|
|
3669
|
+
* Returns a metadata object for class sap.makit.Series.
|
|
3670
|
+
*
|
|
3671
|
+
* @returns Metadata object describing this class
|
|
3672
|
+
*/
|
|
3673
|
+
static getMetadata(): ElementMetadata;
|
|
3674
|
+
/**
|
|
3675
|
+
* Gets current value of property {@link #getColumn column}.
|
|
3676
|
+
*
|
|
3677
|
+
* The name of the column that will be mapped to the chart's Series value
|
|
3678
|
+
*
|
|
3679
|
+
* @returns Value of property `column`
|
|
3680
|
+
*/
|
|
3681
|
+
getColumn(): string;
|
|
3682
|
+
/**
|
|
3683
|
+
* Gets current value of property {@link #getDisplayName displayName}.
|
|
3684
|
+
*
|
|
3685
|
+
* The displayed name of the Series
|
|
3686
|
+
*
|
|
3687
|
+
* @returns Value of property `displayName`
|
|
3688
|
+
*/
|
|
3689
|
+
getDisplayName(): string;
|
|
3690
|
+
/**
|
|
3691
|
+
* Gets current value of property {@link #getFormat format}.
|
|
3692
|
+
*
|
|
3693
|
+
* Number formatting for the value. Accepted values: number currency percent roundedN - where N represents
|
|
3694
|
+
* number of decimal places e.g. rounded4
|
|
3695
|
+
*
|
|
3696
|
+
* @returns Value of property `format`
|
|
3697
|
+
*/
|
|
3698
|
+
getFormat(): string;
|
|
3699
|
+
/**
|
|
3700
|
+
* Sets a new value for property {@link #getColumn column}.
|
|
3701
|
+
*
|
|
3702
|
+
* The name of the column that will be mapped to the chart's Series value
|
|
3703
|
+
*
|
|
3704
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3705
|
+
*
|
|
3706
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3707
|
+
*/
|
|
3708
|
+
setColumn(
|
|
3709
|
+
/**
|
|
3710
|
+
* New value for property `column`
|
|
3711
|
+
*/
|
|
3712
|
+
sColumn?: string
|
|
3713
|
+
): this;
|
|
3714
|
+
/**
|
|
3715
|
+
* Sets a new value for property {@link #getDisplayName displayName}.
|
|
3716
|
+
*
|
|
3717
|
+
* The displayed name of the Series
|
|
3718
|
+
*
|
|
3719
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3720
|
+
*
|
|
3721
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3722
|
+
*/
|
|
3723
|
+
setDisplayName(
|
|
3724
|
+
/**
|
|
3725
|
+
* New value for property `displayName`
|
|
3726
|
+
*/
|
|
3727
|
+
sDisplayName?: string
|
|
3728
|
+
): this;
|
|
3729
|
+
/**
|
|
3730
|
+
* Sets a new value for property {@link #getFormat format}.
|
|
3731
|
+
*
|
|
3732
|
+
* Number formatting for the value. Accepted values: number currency percent roundedN - where N represents
|
|
3733
|
+
* number of decimal places e.g. rounded4
|
|
3734
|
+
*
|
|
3735
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3736
|
+
*
|
|
3737
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3738
|
+
*/
|
|
3739
|
+
setFormat(
|
|
3740
|
+
/**
|
|
3741
|
+
* New value for property `format`
|
|
3742
|
+
*/
|
|
3743
|
+
sFormat?: string
|
|
3744
|
+
): this;
|
|
3745
|
+
}
|
|
3746
|
+
|
|
3747
|
+
export interface $SeriesSettings extends $ElementSettings {
|
|
3748
|
+
/**
|
|
3749
|
+
* The name of the column that will be mapped to the chart's Series value
|
|
3750
|
+
*/
|
|
3751
|
+
column?: string | PropertyBindingInfo;
|
|
3752
|
+
|
|
3753
|
+
/**
|
|
3754
|
+
* The displayed name of the Series
|
|
3755
|
+
*/
|
|
3756
|
+
displayName?: string | PropertyBindingInfo;
|
|
3757
|
+
|
|
3758
|
+
/**
|
|
3759
|
+
* Number formatting for the value. Accepted values: number currency percent roundedN - where N represents
|
|
3760
|
+
* number of decimal places e.g. rounded4
|
|
3761
|
+
*/
|
|
3762
|
+
format?: string | PropertyBindingInfo;
|
|
3763
|
+
}
|
|
3764
|
+
}
|
|
3765
|
+
|
|
3766
|
+
declare module "sap/makit/Value" {
|
|
3767
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
3768
|
+
|
|
3769
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
3770
|
+
|
|
3771
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
3772
|
+
|
|
3773
|
+
/**
|
|
3774
|
+
* @SINCE 1.8
|
|
3775
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
3776
|
+
* will not be supported anymore from 1.38.
|
|
3777
|
+
*
|
|
3778
|
+
* Represents the Value data region of the Chart.
|
|
3779
|
+
*/
|
|
3780
|
+
export default class Value extends UI5Element {
|
|
3781
|
+
/**
|
|
3782
|
+
* Constructor for a new Value.
|
|
3783
|
+
*
|
|
3784
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3785
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3786
|
+
* of the syntax of the settings object.
|
|
3787
|
+
*/
|
|
3788
|
+
constructor(
|
|
3789
|
+
/**
|
|
3790
|
+
* initial settings for the new control
|
|
3791
|
+
*/
|
|
3792
|
+
mSettings?: $ValueSettings
|
|
3793
|
+
);
|
|
3794
|
+
/**
|
|
3795
|
+
* Constructor for a new Value.
|
|
3796
|
+
*
|
|
3797
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
3798
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
3799
|
+
* of the syntax of the settings object.
|
|
3800
|
+
*/
|
|
3801
|
+
constructor(
|
|
3802
|
+
/**
|
|
3803
|
+
* id for the new control, generated automatically if no id is given
|
|
3804
|
+
*/
|
|
3805
|
+
sId?: string,
|
|
3806
|
+
/**
|
|
3807
|
+
* initial settings for the new control
|
|
3808
|
+
*/
|
|
3809
|
+
mSettings?: $ValueSettings
|
|
3810
|
+
);
|
|
3811
|
+
|
|
3812
|
+
/**
|
|
3813
|
+
* Creates a new subclass of class sap.makit.Value with name `sClassName` and enriches it with the information
|
|
3814
|
+
* contained in `oClassInfo`.
|
|
3815
|
+
*
|
|
3816
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
3817
|
+
*
|
|
3818
|
+
* @returns Created class / constructor function
|
|
3819
|
+
*/
|
|
3820
|
+
static extend<T extends Record<string, unknown>>(
|
|
3821
|
+
/**
|
|
3822
|
+
* Name of the class being created
|
|
3823
|
+
*/
|
|
3824
|
+
sClassName: string,
|
|
3825
|
+
/**
|
|
3826
|
+
* Object literal with information about the class
|
|
3827
|
+
*/
|
|
3828
|
+
oClassInfo?: sap.ClassInfo<T, Value>,
|
|
3829
|
+
/**
|
|
3830
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
3831
|
+
* used by this class
|
|
3832
|
+
*/
|
|
3833
|
+
FNMetaImpl?: Function
|
|
3834
|
+
): Function;
|
|
3835
|
+
/**
|
|
3836
|
+
* Returns a metadata object for class sap.makit.Value.
|
|
3837
|
+
*
|
|
3838
|
+
* @returns Metadata object describing this class
|
|
3839
|
+
*/
|
|
3840
|
+
static getMetadata(): ElementMetadata;
|
|
3841
|
+
/**
|
|
3842
|
+
* Gets current value of property {@link #getDisplayName displayName}.
|
|
3843
|
+
*
|
|
3844
|
+
* The text label representing this Value (on value bubble or table's header)
|
|
3845
|
+
*
|
|
3846
|
+
* @returns Value of property `displayName`
|
|
3847
|
+
*/
|
|
3848
|
+
getDisplayName(): string;
|
|
3849
|
+
/**
|
|
3850
|
+
* Gets current value of property {@link #getExpression expression}.
|
|
3851
|
+
*
|
|
3852
|
+
* The user should map the column on this property. The expression allows more advanced column mapping.
|
|
3853
|
+
* Instead of just specifying the column name (e.g. revenueValue), the user can use SAP expression language
|
|
3854
|
+
* e.g. Assuming the user has a revenueValue column and an operatingCost column, the user can specify the
|
|
3855
|
+
* following expression: "revenueValue - operatingCost" the resulting value displayed in the chart will
|
|
3856
|
+
* be the arithmatic operation result on these two columns.
|
|
3857
|
+
*
|
|
3858
|
+
* @returns Value of property `expression`
|
|
3859
|
+
*/
|
|
3860
|
+
getExpression(): string;
|
|
3861
|
+
/**
|
|
3862
|
+
* Gets current value of property {@link #getFormat format}.
|
|
3863
|
+
*
|
|
3864
|
+
* Number formatting for the value. Accepted values: number currency percent roundedN - where N represents
|
|
3865
|
+
* number of decimal places e.g. rounded4
|
|
3866
|
+
*
|
|
3867
|
+
* @returns Value of property `format`
|
|
3868
|
+
*/
|
|
3869
|
+
getFormat(): string;
|
|
3870
|
+
/**
|
|
3871
|
+
* Gets current value of property {@link #getLocale locale}.
|
|
3872
|
+
*
|
|
3873
|
+
* Comma separated locales for specifiying values in different locale. The locale will be mapped in the
|
|
3874
|
+
* same order as the series data. e.g. zh-CH, en-US, de-DE The first zh-CH will be applied to the value
|
|
3875
|
+
* of the first series, en-US will be applied to the second series. Currently will only work with 'currency'
|
|
3876
|
+
* format. Supported locales: en, zh, de, fr, es, ru, ja, pt and their more specific variations such as
|
|
3877
|
+
* en-CA, es-AR, zh-HK, etc.
|
|
3878
|
+
*
|
|
3879
|
+
* @returns Value of property `locale`
|
|
3880
|
+
*/
|
|
3881
|
+
getLocale(): string;
|
|
3882
|
+
/**
|
|
3883
|
+
* Sets a new value for property {@link #getDisplayName displayName}.
|
|
3884
|
+
*
|
|
3885
|
+
* The text label representing this Value (on value bubble or table's header)
|
|
3886
|
+
*
|
|
3887
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3888
|
+
*
|
|
3889
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3890
|
+
*/
|
|
3891
|
+
setDisplayName(
|
|
3892
|
+
/**
|
|
3893
|
+
* New value for property `displayName`
|
|
3894
|
+
*/
|
|
3895
|
+
sDisplayName?: string
|
|
3896
|
+
): this;
|
|
3897
|
+
/**
|
|
3898
|
+
* Sets a new value for property {@link #getExpression expression}.
|
|
3899
|
+
*
|
|
3900
|
+
* The user should map the column on this property. The expression allows more advanced column mapping.
|
|
3901
|
+
* Instead of just specifying the column name (e.g. revenueValue), the user can use SAP expression language
|
|
3902
|
+
* e.g. Assuming the user has a revenueValue column and an operatingCost column, the user can specify the
|
|
3903
|
+
* following expression: "revenueValue - operatingCost" the resulting value displayed in the chart will
|
|
3904
|
+
* be the arithmatic operation result on these two columns.
|
|
3905
|
+
*
|
|
3906
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3907
|
+
*
|
|
3908
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3909
|
+
*/
|
|
3910
|
+
setExpression(
|
|
3911
|
+
/**
|
|
3912
|
+
* New value for property `expression`
|
|
3913
|
+
*/
|
|
3914
|
+
sExpression?: string
|
|
3915
|
+
): this;
|
|
3916
|
+
/**
|
|
3917
|
+
* Sets a new value for property {@link #getFormat format}.
|
|
3918
|
+
*
|
|
3919
|
+
* Number formatting for the value. Accepted values: number currency percent roundedN - where N represents
|
|
3920
|
+
* number of decimal places e.g. rounded4
|
|
3921
|
+
*
|
|
3922
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3923
|
+
*
|
|
3924
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3925
|
+
*/
|
|
3926
|
+
setFormat(
|
|
3927
|
+
/**
|
|
3928
|
+
* New value for property `format`
|
|
3929
|
+
*/
|
|
3930
|
+
sFormat?: string
|
|
3931
|
+
): this;
|
|
3932
|
+
/**
|
|
3933
|
+
* Sets a new value for property {@link #getLocale locale}.
|
|
3934
|
+
*
|
|
3935
|
+
* Comma separated locales for specifiying values in different locale. The locale will be mapped in the
|
|
3936
|
+
* same order as the series data. e.g. zh-CH, en-US, de-DE The first zh-CH will be applied to the value
|
|
3937
|
+
* of the first series, en-US will be applied to the second series. Currently will only work with 'currency'
|
|
3938
|
+
* format. Supported locales: en, zh, de, fr, es, ru, ja, pt and their more specific variations such as
|
|
3939
|
+
* en-CA, es-AR, zh-HK, etc.
|
|
3940
|
+
*
|
|
3941
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3942
|
+
*
|
|
3943
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3944
|
+
*/
|
|
3945
|
+
setLocale(
|
|
3946
|
+
/**
|
|
3947
|
+
* New value for property `locale`
|
|
3948
|
+
*/
|
|
3949
|
+
sLocale?: string
|
|
3950
|
+
): this;
|
|
3951
|
+
}
|
|
3952
|
+
|
|
3953
|
+
export interface $ValueSettings extends $ElementSettings {
|
|
3954
|
+
/**
|
|
3955
|
+
* The user should map the column on this property. The expression allows more advanced column mapping.
|
|
3956
|
+
* Instead of just specifying the column name (e.g. revenueValue), the user can use SAP expression language
|
|
3957
|
+
* e.g. Assuming the user has a revenueValue column and an operatingCost column, the user can specify the
|
|
3958
|
+
* following expression: "revenueValue - operatingCost" the resulting value displayed in the chart will
|
|
3959
|
+
* be the arithmatic operation result on these two columns.
|
|
3960
|
+
*/
|
|
3961
|
+
expression?: string | PropertyBindingInfo;
|
|
3962
|
+
|
|
3963
|
+
/**
|
|
3964
|
+
* The text label representing this Value (on value bubble or table's header)
|
|
3965
|
+
*/
|
|
3966
|
+
displayName?: string | PropertyBindingInfo;
|
|
3967
|
+
|
|
3968
|
+
/**
|
|
3969
|
+
* Number formatting for the value. Accepted values: number currency percent roundedN - where N represents
|
|
3970
|
+
* number of decimal places e.g. rounded4
|
|
3971
|
+
*/
|
|
3972
|
+
format?: string | PropertyBindingInfo;
|
|
3973
|
+
|
|
3974
|
+
/**
|
|
3975
|
+
* Comma separated locales for specifiying values in different locale. The locale will be mapped in the
|
|
3976
|
+
* same order as the series data. e.g. zh-CH, en-US, de-DE The first zh-CH will be applied to the value
|
|
3977
|
+
* of the first series, en-US will be applied to the second series. Currently will only work with 'currency'
|
|
3978
|
+
* format. Supported locales: en, zh, de, fr, es, ru, ja, pt and their more specific variations such as
|
|
3979
|
+
* en-CA, es-AR, zh-HK, etc.
|
|
3980
|
+
*/
|
|
3981
|
+
locale?: string | PropertyBindingInfo;
|
|
3982
|
+
}
|
|
3983
|
+
}
|
|
3984
|
+
|
|
3985
|
+
declare module "sap/makit/ValueAxis" {
|
|
3986
|
+
import { default as Axis, $AxisSettings } from "sap/makit/Axis";
|
|
3987
|
+
|
|
3988
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
3989
|
+
|
|
3990
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
3991
|
+
|
|
3992
|
+
/**
|
|
3993
|
+
* @SINCE 1.8
|
|
3994
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
3995
|
+
* will not be supported anymore from 1.38.
|
|
3996
|
+
*
|
|
3997
|
+
* Contains the properties of the Value's Axis.
|
|
3998
|
+
*/
|
|
3999
|
+
export default class ValueAxis extends Axis {
|
|
4000
|
+
/**
|
|
4001
|
+
* Constructor for a new ValueAxis.
|
|
4002
|
+
*
|
|
4003
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
4004
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
4005
|
+
* of the syntax of the settings object.
|
|
4006
|
+
*/
|
|
4007
|
+
constructor(
|
|
4008
|
+
/**
|
|
4009
|
+
* initial settings for the new control
|
|
4010
|
+
*/
|
|
4011
|
+
mSettings?: $ValueAxisSettings
|
|
4012
|
+
);
|
|
4013
|
+
/**
|
|
4014
|
+
* Constructor for a new ValueAxis.
|
|
4015
|
+
*
|
|
4016
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
4017
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
4018
|
+
* of the syntax of the settings object.
|
|
4019
|
+
*/
|
|
4020
|
+
constructor(
|
|
4021
|
+
/**
|
|
4022
|
+
* id for the new control, generated automatically if no id is given
|
|
4023
|
+
*/
|
|
4024
|
+
sId?: string,
|
|
4025
|
+
/**
|
|
4026
|
+
* initial settings for the new control
|
|
4027
|
+
*/
|
|
4028
|
+
mSettings?: $ValueAxisSettings
|
|
4029
|
+
);
|
|
4030
|
+
|
|
4031
|
+
/**
|
|
4032
|
+
* Creates a new subclass of class sap.makit.ValueAxis with name `sClassName` and enriches it with the information
|
|
4033
|
+
* contained in `oClassInfo`.
|
|
4034
|
+
*
|
|
4035
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.makit.Axis.extend}.
|
|
4036
|
+
*
|
|
4037
|
+
* @returns Created class / constructor function
|
|
4038
|
+
*/
|
|
4039
|
+
static extend<T extends Record<string, unknown>>(
|
|
4040
|
+
/**
|
|
4041
|
+
* Name of the class being created
|
|
4042
|
+
*/
|
|
4043
|
+
sClassName: string,
|
|
4044
|
+
/**
|
|
4045
|
+
* Object literal with information about the class
|
|
4046
|
+
*/
|
|
4047
|
+
oClassInfo?: sap.ClassInfo<T, ValueAxis>,
|
|
4048
|
+
/**
|
|
4049
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
4050
|
+
* used by this class
|
|
4051
|
+
*/
|
|
4052
|
+
FNMetaImpl?: Function
|
|
4053
|
+
): Function;
|
|
4054
|
+
/**
|
|
4055
|
+
* Returns a metadata object for class sap.makit.ValueAxis.
|
|
4056
|
+
*
|
|
4057
|
+
* @returns Metadata object describing this class
|
|
4058
|
+
*/
|
|
4059
|
+
static getMetadata(): ElementMetadata;
|
|
4060
|
+
/**
|
|
4061
|
+
* Gets current value of property {@link #getMax max}.
|
|
4062
|
+
*
|
|
4063
|
+
* Highest displayed value on the Value Axis (this value will be automatically adjusted to nearest major
|
|
4064
|
+
* tick value depending on the value's range)
|
|
4065
|
+
*
|
|
4066
|
+
* @returns Value of property `max`
|
|
4067
|
+
*/
|
|
4068
|
+
getMax(): string;
|
|
4069
|
+
/**
|
|
4070
|
+
* Gets current value of property {@link #getMin min}.
|
|
4071
|
+
*
|
|
4072
|
+
* Highest displayed value on the Value Axis (this value will be automatically adjusted to nearest major
|
|
4073
|
+
* tick value depending on the value's range). Set to empty string to switch back to automatic calculation.
|
|
4074
|
+
*
|
|
4075
|
+
* @returns Value of property `min`
|
|
4076
|
+
*/
|
|
4077
|
+
getMin(): string;
|
|
4078
|
+
/**
|
|
4079
|
+
* Sets a new value for property {@link #getMax max}.
|
|
4080
|
+
*
|
|
4081
|
+
* Highest displayed value on the Value Axis (this value will be automatically adjusted to nearest major
|
|
4082
|
+
* tick value depending on the value's range)
|
|
4083
|
+
*
|
|
4084
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4085
|
+
*
|
|
4086
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
4087
|
+
*/
|
|
4088
|
+
setMax(
|
|
4089
|
+
/**
|
|
4090
|
+
* New value for property `max`
|
|
4091
|
+
*/
|
|
4092
|
+
sMax?: string
|
|
4093
|
+
): this;
|
|
4094
|
+
/**
|
|
4095
|
+
* Sets a new value for property {@link #getMin min}.
|
|
4096
|
+
*
|
|
4097
|
+
* Highest displayed value on the Value Axis (this value will be automatically adjusted to nearest major
|
|
4098
|
+
* tick value depending on the value's range). Set to empty string to switch back to automatic calculation.
|
|
4099
|
+
*
|
|
4100
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4101
|
+
*
|
|
4102
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
4103
|
+
*/
|
|
4104
|
+
setMin(
|
|
4105
|
+
/**
|
|
4106
|
+
* New value for property `min`
|
|
4107
|
+
*/
|
|
4108
|
+
sMin?: string
|
|
4109
|
+
): this;
|
|
4110
|
+
}
|
|
4111
|
+
|
|
4112
|
+
export interface $ValueAxisSettings extends $AxisSettings {
|
|
4113
|
+
/**
|
|
4114
|
+
* Highest displayed value on the Value Axis (this value will be automatically adjusted to nearest major
|
|
4115
|
+
* tick value depending on the value's range). Set to empty string to switch back to automatic calculation.
|
|
4116
|
+
*/
|
|
4117
|
+
min?: string | PropertyBindingInfo;
|
|
4118
|
+
|
|
4119
|
+
/**
|
|
4120
|
+
* Highest displayed value on the Value Axis (this value will be automatically adjusted to nearest major
|
|
4121
|
+
* tick value depending on the value's range)
|
|
4122
|
+
*/
|
|
4123
|
+
max?: string | PropertyBindingInfo;
|
|
4124
|
+
}
|
|
4125
|
+
}
|
|
4126
|
+
|
|
4127
|
+
declare module "sap/makit/ValueBubble" {
|
|
4128
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
4129
|
+
|
|
4130
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
4131
|
+
|
|
4132
|
+
import { ValueBubblePosition, ValueBubbleStyle } from "sap/makit/library";
|
|
4133
|
+
|
|
4134
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
4135
|
+
|
|
4136
|
+
/**
|
|
4137
|
+
* @SINCE 1.8
|
|
4138
|
+
* @deprecated (since 1.38) - MAKIT charts have been replaced with sap.viz and vizFrame in 1.38. This control
|
|
4139
|
+
* will not be supported anymore from 1.38.
|
|
4140
|
+
*
|
|
4141
|
+
* The properties of the Chart's Value Bubble.
|
|
4142
|
+
*/
|
|
4143
|
+
export default class ValueBubble extends UI5Element {
|
|
4144
|
+
/**
|
|
4145
|
+
* Constructor for a new ValueBubble.
|
|
4146
|
+
*
|
|
4147
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
4148
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
4149
|
+
* of the syntax of the settings object.
|
|
4150
|
+
*/
|
|
4151
|
+
constructor(
|
|
4152
|
+
/**
|
|
4153
|
+
* initial settings for the new control
|
|
4154
|
+
*/
|
|
4155
|
+
mSettings?: $ValueBubbleSettings
|
|
4156
|
+
);
|
|
4157
|
+
/**
|
|
4158
|
+
* Constructor for a new ValueBubble.
|
|
4159
|
+
*
|
|
4160
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
4161
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
4162
|
+
* of the syntax of the settings object.
|
|
4163
|
+
*/
|
|
4164
|
+
constructor(
|
|
4165
|
+
/**
|
|
4166
|
+
* id for the new control, generated automatically if no id is given
|
|
4167
|
+
*/
|
|
4168
|
+
sId?: string,
|
|
4169
|
+
/**
|
|
4170
|
+
* initial settings for the new control
|
|
4171
|
+
*/
|
|
4172
|
+
mSettings?: $ValueBubbleSettings
|
|
4173
|
+
);
|
|
4174
|
+
|
|
4175
|
+
/**
|
|
4176
|
+
* Creates a new subclass of class sap.makit.ValueBubble with name `sClassName` and enriches it with the
|
|
4177
|
+
* information contained in `oClassInfo`.
|
|
4178
|
+
*
|
|
4179
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
4180
|
+
*
|
|
4181
|
+
* @returns Created class / constructor function
|
|
4182
|
+
*/
|
|
4183
|
+
static extend<T extends Record<string, unknown>>(
|
|
4184
|
+
/**
|
|
4185
|
+
* Name of the class being created
|
|
4186
|
+
*/
|
|
4187
|
+
sClassName: string,
|
|
4188
|
+
/**
|
|
4189
|
+
* Object literal with information about the class
|
|
4190
|
+
*/
|
|
4191
|
+
oClassInfo?: sap.ClassInfo<T, ValueBubble>,
|
|
4192
|
+
/**
|
|
4193
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
4194
|
+
* used by this class
|
|
4195
|
+
*/
|
|
4196
|
+
FNMetaImpl?: Function
|
|
4197
|
+
): Function;
|
|
4198
|
+
/**
|
|
4199
|
+
* Returns a metadata object for class sap.makit.ValueBubble.
|
|
4200
|
+
*
|
|
4201
|
+
* @returns Metadata object describing this class
|
|
4202
|
+
*/
|
|
4203
|
+
static getMetadata(): ElementMetadata;
|
|
4204
|
+
/**
|
|
4205
|
+
* Gets current value of property {@link #getPosition position}.
|
|
4206
|
+
*
|
|
4207
|
+
* The position of the Value Bubble (Pie or Donut chart only)
|
|
4208
|
+
*
|
|
4209
|
+
* Default value is `Top`.
|
|
4210
|
+
*
|
|
4211
|
+
* @returns Value of property `position`
|
|
4212
|
+
*/
|
|
4213
|
+
getPosition(): ValueBubblePosition | keyof typeof ValueBubblePosition;
|
|
4214
|
+
/**
|
|
4215
|
+
* Gets current value of property {@link #getShowCategoryDisplayName showCategoryDisplayName}.
|
|
4216
|
+
*
|
|
4217
|
+
* Whether to display category's display name on the Value Bubble
|
|
4218
|
+
*
|
|
4219
|
+
* Default value is `true`.
|
|
4220
|
+
*
|
|
4221
|
+
* @returns Value of property `showCategoryDisplayName`
|
|
4222
|
+
*/
|
|
4223
|
+
getShowCategoryDisplayName(): boolean;
|
|
4224
|
+
/**
|
|
4225
|
+
* Gets current value of property {@link #getShowCategoryText showCategoryText}.
|
|
4226
|
+
*
|
|
4227
|
+
* Whether to display category's text on the Value Bubble
|
|
4228
|
+
*
|
|
4229
|
+
* Default value is `true`.
|
|
4230
|
+
*
|
|
4231
|
+
* @returns Value of property `showCategoryText`
|
|
4232
|
+
*/
|
|
4233
|
+
getShowCategoryText(): boolean;
|
|
4234
|
+
/**
|
|
4235
|
+
* Gets current value of property {@link #getShowLegendLabel showLegendLabel}.
|
|
4236
|
+
*
|
|
4237
|
+
* Whether to display legend's label (Pie or Donut chart only)
|
|
4238
|
+
*
|
|
4239
|
+
* Default value is `true`.
|
|
4240
|
+
*
|
|
4241
|
+
* @returns Value of property `showLegendLabel`
|
|
4242
|
+
*/
|
|
4243
|
+
getShowLegendLabel(): boolean;
|
|
4244
|
+
/**
|
|
4245
|
+
* Gets current value of property {@link #getShowNullValue showNullValue}.
|
|
4246
|
+
*
|
|
4247
|
+
* Whether to render null item on the Value Bubble
|
|
4248
|
+
*
|
|
4249
|
+
* Default value is `true`.
|
|
4250
|
+
*
|
|
4251
|
+
* @returns Value of property `showNullValue`
|
|
4252
|
+
*/
|
|
4253
|
+
getShowNullValue(): boolean;
|
|
4254
|
+
/**
|
|
4255
|
+
* Gets current value of property {@link #getShowValueDisplayName showValueDisplayName}.
|
|
4256
|
+
*
|
|
4257
|
+
* Whether to display value's display name on the Value Bubble
|
|
4258
|
+
*
|
|
4259
|
+
* Default value is `true`.
|
|
4260
|
+
*
|
|
4261
|
+
* @returns Value of property `showValueDisplayName`
|
|
4262
|
+
*/
|
|
4263
|
+
getShowValueDisplayName(): boolean;
|
|
4264
|
+
/**
|
|
4265
|
+
* Gets current value of property {@link #getShowValueOnPieChart showValueOnPieChart}.
|
|
4266
|
+
*
|
|
4267
|
+
* Whether to display value on Pie or Donut chart
|
|
4268
|
+
*
|
|
4269
|
+
* Default value is `false`.
|
|
4270
|
+
*
|
|
4271
|
+
* @returns Value of property `showValueOnPieChart`
|
|
4272
|
+
*/
|
|
4273
|
+
getShowValueOnPieChart(): boolean;
|
|
4274
|
+
/**
|
|
4275
|
+
* Gets current value of property {@link #getStyle style}.
|
|
4276
|
+
*
|
|
4277
|
+
* Value Bubble positioning style (All the chart types except: Pie/Donut/HBar chart)
|
|
4278
|
+
*
|
|
4279
|
+
* Default value is `Top`.
|
|
4280
|
+
*
|
|
4281
|
+
* @returns Value of property `style`
|
|
4282
|
+
*/
|
|
4283
|
+
getStyle(): ValueBubbleStyle | keyof typeof ValueBubbleStyle;
|
|
4284
|
+
/**
|
|
4285
|
+
* Gets current value of property {@link #getVisible visible}.
|
|
4286
|
+
*
|
|
4287
|
+
* Whether the Value Bubble is visible
|
|
4288
|
+
*
|
|
4289
|
+
* Default value is `true`.
|
|
4290
|
+
*
|
|
4291
|
+
* @returns Value of property `visible`
|
|
4292
|
+
*/
|
|
4293
|
+
getVisible(): boolean;
|
|
4294
|
+
/**
|
|
4295
|
+
* Sets a new value for property {@link #getPosition position}.
|
|
4296
|
+
*
|
|
4297
|
+
* The position of the Value Bubble (Pie or Donut chart only)
|
|
4298
|
+
*
|
|
4299
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4300
|
+
*
|
|
4301
|
+
* Default value is `Top`.
|
|
4302
|
+
*
|
|
4303
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
4304
|
+
*/
|
|
4305
|
+
setPosition(
|
|
4306
|
+
/**
|
|
4307
|
+
* New value for property `position`
|
|
4308
|
+
*/
|
|
4309
|
+
sPosition?: ValueBubblePosition | keyof typeof ValueBubblePosition
|
|
4310
|
+
): this;
|
|
4311
|
+
/**
|
|
4312
|
+
* Sets a new value for property {@link #getShowCategoryDisplayName showCategoryDisplayName}.
|
|
4313
|
+
*
|
|
4314
|
+
* Whether to display category's display name on the Value Bubble
|
|
4315
|
+
*
|
|
4316
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4317
|
+
*
|
|
4318
|
+
* Default value is `true`.
|
|
4319
|
+
*
|
|
4320
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
4321
|
+
*/
|
|
4322
|
+
setShowCategoryDisplayName(
|
|
4323
|
+
/**
|
|
4324
|
+
* New value for property `showCategoryDisplayName`
|
|
4325
|
+
*/
|
|
4326
|
+
bShowCategoryDisplayName?: boolean
|
|
4327
|
+
): this;
|
|
4328
|
+
/**
|
|
4329
|
+
* Sets a new value for property {@link #getShowCategoryText showCategoryText}.
|
|
4330
|
+
*
|
|
4331
|
+
* Whether to display category's text on the Value Bubble
|
|
4332
|
+
*
|
|
4333
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4334
|
+
*
|
|
4335
|
+
* Default value is `true`.
|
|
4336
|
+
*
|
|
4337
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
4338
|
+
*/
|
|
4339
|
+
setShowCategoryText(
|
|
4340
|
+
/**
|
|
4341
|
+
* New value for property `showCategoryText`
|
|
4342
|
+
*/
|
|
4343
|
+
bShowCategoryText?: boolean
|
|
4344
|
+
): this;
|
|
4345
|
+
/**
|
|
4346
|
+
* Sets a new value for property {@link #getShowLegendLabel showLegendLabel}.
|
|
4347
|
+
*
|
|
4348
|
+
* Whether to display legend's label (Pie or Donut chart only)
|
|
4349
|
+
*
|
|
4350
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4351
|
+
*
|
|
4352
|
+
* Default value is `true`.
|
|
4353
|
+
*
|
|
4354
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
4355
|
+
*/
|
|
4356
|
+
setShowLegendLabel(
|
|
4357
|
+
/**
|
|
4358
|
+
* New value for property `showLegendLabel`
|
|
4359
|
+
*/
|
|
4360
|
+
bShowLegendLabel?: boolean
|
|
4361
|
+
): this;
|
|
4362
|
+
/**
|
|
4363
|
+
* Sets a new value for property {@link #getShowNullValue showNullValue}.
|
|
4364
|
+
*
|
|
4365
|
+
* Whether to render null item on the Value Bubble
|
|
4366
|
+
*
|
|
4367
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4368
|
+
*
|
|
4369
|
+
* Default value is `true`.
|
|
4370
|
+
*
|
|
4371
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
4372
|
+
*/
|
|
4373
|
+
setShowNullValue(
|
|
4374
|
+
/**
|
|
4375
|
+
* New value for property `showNullValue`
|
|
4376
|
+
*/
|
|
4377
|
+
bShowNullValue?: boolean
|
|
4378
|
+
): this;
|
|
4379
|
+
/**
|
|
4380
|
+
* Sets a new value for property {@link #getShowValueDisplayName showValueDisplayName}.
|
|
4381
|
+
*
|
|
4382
|
+
* Whether to display value's display name on the Value Bubble
|
|
4383
|
+
*
|
|
4384
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4385
|
+
*
|
|
4386
|
+
* Default value is `true`.
|
|
4387
|
+
*
|
|
4388
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
4389
|
+
*/
|
|
4390
|
+
setShowValueDisplayName(
|
|
4391
|
+
/**
|
|
4392
|
+
* New value for property `showValueDisplayName`
|
|
4393
|
+
*/
|
|
4394
|
+
bShowValueDisplayName?: boolean
|
|
4395
|
+
): this;
|
|
4396
|
+
/**
|
|
4397
|
+
* Sets a new value for property {@link #getShowValueOnPieChart showValueOnPieChart}.
|
|
4398
|
+
*
|
|
4399
|
+
* Whether to display value on Pie or Donut chart
|
|
4400
|
+
*
|
|
4401
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4402
|
+
*
|
|
4403
|
+
* Default value is `false`.
|
|
4404
|
+
*
|
|
4405
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
4406
|
+
*/
|
|
4407
|
+
setShowValueOnPieChart(
|
|
4408
|
+
/**
|
|
4409
|
+
* New value for property `showValueOnPieChart`
|
|
4410
|
+
*/
|
|
4411
|
+
bShowValueOnPieChart?: boolean
|
|
4412
|
+
): this;
|
|
4413
|
+
/**
|
|
4414
|
+
* Sets a new value for property {@link #getStyle style}.
|
|
4415
|
+
*
|
|
4416
|
+
* Value Bubble positioning style (All the chart types except: Pie/Donut/HBar chart)
|
|
4417
|
+
*
|
|
4418
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4419
|
+
*
|
|
4420
|
+
* Default value is `Top`.
|
|
4421
|
+
*
|
|
4422
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
4423
|
+
*/
|
|
4424
|
+
setStyle(
|
|
4425
|
+
/**
|
|
4426
|
+
* New value for property `style`
|
|
4427
|
+
*/
|
|
4428
|
+
sStyle?: ValueBubbleStyle | keyof typeof ValueBubbleStyle
|
|
4429
|
+
): this;
|
|
4430
|
+
/**
|
|
4431
|
+
* Sets a new value for property {@link #getVisible visible}.
|
|
4432
|
+
*
|
|
4433
|
+
* Whether the Value Bubble is visible
|
|
4434
|
+
*
|
|
4435
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
4436
|
+
*
|
|
4437
|
+
* Default value is `true`.
|
|
4438
|
+
*
|
|
4439
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
4440
|
+
*/
|
|
4441
|
+
setVisible(
|
|
4442
|
+
/**
|
|
4443
|
+
* New value for property `visible`
|
|
4444
|
+
*/
|
|
4445
|
+
bVisible?: boolean
|
|
4446
|
+
): this;
|
|
4447
|
+
}
|
|
4448
|
+
|
|
4449
|
+
export interface $ValueBubbleSettings extends $ElementSettings {
|
|
4450
|
+
/**
|
|
4451
|
+
* Whether to display category's text on the Value Bubble
|
|
4452
|
+
*/
|
|
4453
|
+
showCategoryText?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4454
|
+
|
|
4455
|
+
/**
|
|
4456
|
+
* Whether to display category's display name on the Value Bubble
|
|
4457
|
+
*/
|
|
4458
|
+
showCategoryDisplayName?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4459
|
+
|
|
4460
|
+
/**
|
|
4461
|
+
* Whether to display value's display name on the Value Bubble
|
|
4462
|
+
*/
|
|
4463
|
+
showValueDisplayName?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4464
|
+
|
|
4465
|
+
/**
|
|
4466
|
+
* Whether to display value on Pie or Donut chart
|
|
4467
|
+
*/
|
|
4468
|
+
showValueOnPieChart?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4469
|
+
|
|
4470
|
+
/**
|
|
4471
|
+
* Whether to display legend's label (Pie or Donut chart only)
|
|
4472
|
+
*/
|
|
4473
|
+
showLegendLabel?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4474
|
+
|
|
4475
|
+
/**
|
|
4476
|
+
* Whether to render null item on the Value Bubble
|
|
4477
|
+
*/
|
|
4478
|
+
showNullValue?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4479
|
+
|
|
4480
|
+
/**
|
|
4481
|
+
* The position of the Value Bubble (Pie or Donut chart only)
|
|
4482
|
+
*/
|
|
4483
|
+
position?:
|
|
4484
|
+
| (ValueBubblePosition | keyof typeof ValueBubblePosition)
|
|
4485
|
+
| PropertyBindingInfo
|
|
4486
|
+
| `{${string}}`;
|
|
4487
|
+
|
|
4488
|
+
/**
|
|
4489
|
+
* Value Bubble positioning style (All the chart types except: Pie/Donut/HBar chart)
|
|
4490
|
+
*/
|
|
4491
|
+
style?:
|
|
4492
|
+
| (ValueBubbleStyle | keyof typeof ValueBubbleStyle)
|
|
4493
|
+
| PropertyBindingInfo
|
|
4494
|
+
| `{${string}}`;
|
|
4495
|
+
|
|
4496
|
+
/**
|
|
4497
|
+
* Whether the Value Bubble is visible
|
|
4498
|
+
*/
|
|
4499
|
+
visible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
4500
|
+
}
|
|
4501
|
+
}
|
|
4502
|
+
|
|
4503
|
+
declare namespace sap {
|
|
4504
|
+
interface IUI5DefineDependencyNames {
|
|
4505
|
+
"sap/makit/Axis": undefined;
|
|
4506
|
+
|
|
4507
|
+
"sap/makit/Category": undefined;
|
|
4508
|
+
|
|
4509
|
+
"sap/makit/CategoryAxis": undefined;
|
|
4510
|
+
|
|
4511
|
+
"sap/makit/Chart": undefined;
|
|
4512
|
+
|
|
4513
|
+
"sap/makit/Column": undefined;
|
|
4514
|
+
|
|
4515
|
+
"sap/makit/CombinationChart": undefined;
|
|
4516
|
+
|
|
4517
|
+
"sap/makit/Layer": undefined;
|
|
4518
|
+
|
|
4519
|
+
"sap/makit/library": undefined;
|
|
4520
|
+
|
|
4521
|
+
"sap/makit/MakitLib": undefined;
|
|
4522
|
+
|
|
4523
|
+
"sap/makit/Row": undefined;
|
|
4524
|
+
|
|
4525
|
+
"sap/makit/Series": undefined;
|
|
4526
|
+
|
|
4527
|
+
"sap/makit/Value": undefined;
|
|
4528
|
+
|
|
4529
|
+
"sap/makit/ValueAxis": undefined;
|
|
4530
|
+
|
|
4531
|
+
"sap/makit/ValueBubble": undefined;
|
|
4532
|
+
}
|
|
4533
|
+
}
|