@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.
Files changed (66) hide show
  1. package/LICENSE.txt +35 -0
  2. package/README.md +35 -0
  3. package/package.json +23 -0
  4. package/types/index.d.ts +67 -0
  5. package/types/sap.apf.d.ts +1026 -0
  6. package/types/sap.ca.ui.d.ts +14005 -0
  7. package/types/sap.chart.d.ts +4815 -0
  8. package/types/sap.collaboration.d.ts +2704 -0
  9. package/types/sap.esh.search.ui.d.ts +1595 -0
  10. package/types/sap.f.d.ts +20085 -0
  11. package/types/sap.fe.core.d.ts +1508 -0
  12. package/types/sap.fe.macros.d.ts +975 -0
  13. package/types/sap.fe.navigation.d.ts +917 -0
  14. package/types/sap.fe.templates.d.ts +522 -0
  15. package/types/sap.fe.test.d.ts +3533 -0
  16. package/types/sap.feedback.ui.d.ts +3 -0
  17. package/types/sap.gantt.d.ts +51684 -0
  18. package/types/sap.insights.d.ts +23 -0
  19. package/types/sap.landvisz.d.ts +7952 -0
  20. package/types/sap.m.d.ts +147796 -0
  21. package/types/sap.makit.d.ts +4533 -0
  22. package/types/sap.me.d.ts +3665 -0
  23. package/types/sap.ndc.d.ts +774 -0
  24. package/types/sap.ovp.d.ts +176 -0
  25. package/types/sap.rules.ui.d.ts +1471 -0
  26. package/types/sap.sac.df.d.ts +2292 -0
  27. package/types/sap.sac.grid.d.ts +774 -0
  28. package/types/sap.suite.ui.commons.d.ts +46971 -0
  29. package/types/sap.suite.ui.generic.template.d.ts +3431 -0
  30. package/types/sap.suite.ui.microchart.d.ts +12652 -0
  31. package/types/sap.tnt.d.ts +2227 -0
  32. package/types/sap.ui.codeeditor.d.ts +693 -0
  33. package/types/sap.ui.commons.d.ts +30235 -0
  34. package/types/sap.ui.comp.d.ts +37411 -0
  35. package/types/sap.ui.core.d.ts +78872 -0
  36. package/types/sap.ui.dt.d.ts +3 -0
  37. package/types/sap.ui.export.d.ts +843 -0
  38. package/types/sap.ui.fl.d.ts +1663 -0
  39. package/types/sap.ui.generic.app.d.ts +2683 -0
  40. package/types/sap.ui.generic.template.d.ts +3 -0
  41. package/types/sap.ui.integration.d.ts +4032 -0
  42. package/types/sap.ui.layout.d.ts +14472 -0
  43. package/types/sap.ui.mdc.d.ts +476 -0
  44. package/types/sap.ui.richtexteditor.d.ts +1666 -0
  45. package/types/sap.ui.rta.d.ts +124 -0
  46. package/types/sap.ui.suite.d.ts +685 -0
  47. package/types/sap.ui.support.d.ts +453 -0
  48. package/types/sap.ui.table.d.ts +9325 -0
  49. package/types/sap.ui.testrecorder.d.ts +9 -0
  50. package/types/sap.ui.unified.d.ts +20640 -0
  51. package/types/sap.ui.ux3.d.ts +18288 -0
  52. package/types/sap.ui.vbm.d.ts +17251 -0
  53. package/types/sap.ui.vk.d.ts +42381 -0
  54. package/types/sap.ui.vtm.d.ts +10547 -0
  55. package/types/sap.ui.webc.common.d.ts +113 -0
  56. package/types/sap.ui.webc.fiori.d.ts +13850 -0
  57. package/types/sap.ui.webc.main.d.ts +40833 -0
  58. package/types/sap.uiext.inbox.d.ts +4079 -0
  59. package/types/sap.ushell.d.ts +10255 -0
  60. package/types/sap.ushell_abap.d.ts +9 -0
  61. package/types/sap.uxap.d.ts +7636 -0
  62. package/types/sap.viz.d.ts +51209 -0
  63. package/types/sap.webanalytics.core.d.ts +3 -0
  64. package/types/sap.zen.commons.d.ts +1542 -0
  65. package/types/sap.zen.crosstab.d.ts +1159 -0
  66. package/types/sap.zen.dsh.d.ts +2132 -0
@@ -0,0 +1,4815 @@
1
+ // For Library Version: 1.113.0
2
+
3
+ declare module "sap/chart/library" {
4
+ import Dimension from "sap/chart/data/Dimension";
5
+
6
+ import Measure from "sap/chart/data/Measure";
7
+
8
+ /**
9
+ * Enumeration for supported message types in analytical chart.
10
+ */
11
+ export enum MessageId {
12
+ /**
13
+ * Multiple units message, multiple unites are not allowed in one measure for analytical chart.
14
+ */
15
+ MultipleUnits = "MULTIPLE_UNITS",
16
+ /**
17
+ * No data message, metadata is defined but all data values are empty.
18
+ */
19
+ NoData = "NO_DATA",
20
+ }
21
+ /**
22
+ * Enumeration for supported selection behavior in analytical chart
23
+ */
24
+ export enum SelectionBehavior {
25
+ /**
26
+ * Category selection behavior, one category of data points can be selected at once.
27
+ */
28
+ Category = "CATEGORY",
29
+ /**
30
+ * Data point selection behavior, only one data point can be selected at once.
31
+ */
32
+ DataPoint = "DATAPOINT",
33
+ /**
34
+ * Series selection behavior, one seies of data points can be selected at once.
35
+ */
36
+ Series = "SERIES",
37
+ }
38
+ /**
39
+ * Enumeration for supported selection mode in analytical chart
40
+ */
41
+ export enum SelectionMode {
42
+ /**
43
+ * Multi selection mode, multiple sets of data points can be selected at once.
44
+ */
45
+ Multi = "MULTIPLE",
46
+ /**
47
+ * None selection mode, no data points can be selected.
48
+ */
49
+ None = "NONE",
50
+ /**
51
+ * Single selection mode, only one set of data points can be selected at once.
52
+ */
53
+ Single = "SINGLE",
54
+ }
55
+
56
+ export namespace api {
57
+ /**
58
+ * Get the Dimensions and Measures layout for a certain ChartType with provided Dimensions and Measures.
59
+ *
60
+ * @returns the chart layout object of the following form:
61
+ * ```javascript
62
+ *
63
+ * {
64
+ * dimensions: [], // names of dimensions that will be rendered
65
+ * measures: [], // names of measures that will be rendered
66
+ * errors: [], // reasons of why the chart cannot be rendered with the given (chartType, dimensions, measures) combination
67
+ * }
68
+ * ```
69
+ */
70
+ function getChartTypeLayout(
71
+ /**
72
+ * chart type
73
+ */
74
+ sChartType: string,
75
+ /**
76
+ * visible Dimensions of the form {name: sName} or {@link sap.chart.data.Dimension} instance.
77
+ */
78
+ aDimensions: object[] | Dimension[],
79
+ /**
80
+ * visible Measures of the form {name: sName} or {@link sap.chart.data.Measure} instance.
81
+ */
82
+ aMeasures: object[] | Measure[]
83
+ ): object;
84
+ /**
85
+ * Returns all chart types currently supported by chart control (subset of viz types).
86
+ *
87
+ * @returns a map with chartType as key, localized chart name as value.
88
+ */
89
+ function getChartTypes(): object;
90
+ }
91
+
92
+ export namespace coloring {
93
+ /**
94
+ * Enumeration for supported Gradation diverging color scheme in analytical chart
95
+ */
96
+ enum GradationDivergingColorScheme {
97
+ /**
98
+ * PositiveToNegative
99
+ */
100
+ ColdToHot = "ColdToHot",
101
+ /**
102
+ * HotToCold
103
+ */
104
+ HotToCold = "HotToCold",
105
+ /**
106
+ * NegativeToPositive
107
+ */
108
+ NegativeToPositive = "NegativeToPositive",
109
+ /**
110
+ * NoSemantics
111
+ */
112
+ NoSemantics = "NoSemantics",
113
+ /**
114
+ * PositiveToNegative
115
+ */
116
+ PositiveToNegative = "PositiveToNegative",
117
+ }
118
+ /**
119
+ * Enumeration for supported Gradation color saturation in analytical chart
120
+ */
121
+ enum GradationSaturation {
122
+ /**
123
+ * DarkToLight
124
+ */
125
+ DarkToLight = "DarkToLight",
126
+ /**
127
+ * LightToDark
128
+ */
129
+ LightToDark = "LightToDark",
130
+ }
131
+ /**
132
+ * Enumeration for supported Gradation single color scheme in analytical chart
133
+ */
134
+ enum GradationSingleColorScheme {
135
+ /**
136
+ * Negative
137
+ */
138
+ Negative = "Negative",
139
+ /**
140
+ * NoSemantics
141
+ */
142
+ NoSemantics = "NoSemantics",
143
+ /**
144
+ * Positive
145
+ */
146
+ Positive = "Positive",
147
+ }
148
+ /**
149
+ * Enumeration for supported Gradation target color scheme in analytical chart
150
+ */
151
+ enum GradationTargetColorScheme {
152
+ /**
153
+ * PositiveTarget
154
+ */
155
+ PositiveTarget = "PositiveTarget",
156
+ }
157
+ /**
158
+ * Enumeration for supported ImprovementDirection types in analytical chart
159
+ */
160
+ enum ImprovementDirectionType {
161
+ /**
162
+ * Higher is better.
163
+ *
164
+ * Positive if the value is greater than or equal to `AcceptanceRangeLowValue`.
165
+ *
166
+ * Neutral if the value is lower than `AcceptanceRangeLowValue` and greater than or equal to `ToleranceRangeLowValue`.
167
+ *
168
+ * Critical if the value is lower than `ToleranceRangeLowValue` and greater than or equal to `DeviationRangeLowValue`.
169
+ *
170
+ * Negative if the value is lower than `DeviationRangeLowValue`.
171
+ */
172
+ Maximize = "Maximize",
173
+ /**
174
+ * Lower is better.
175
+ *
176
+ * Positive if the value is lower than or equal to `AcceptanceRangeHighValue`.
177
+ *
178
+ * Neutral if the value is greater than `AcceptanceRangeHighValue` and lower than or equal to `ToleranceRangeHighValue`.
179
+ *
180
+ * Critical if the value is greater than `ToleranceRangeHighValue` and lower than or equal to `DeviationRangeHighValue`.
181
+ *
182
+ * Negative if the value is greater than `DeviationRangeHighValue`.
183
+ */
184
+ Minimize = "Minimize",
185
+ /**
186
+ * Closer to the target is better.
187
+ *
188
+ * Positive if the value is greater than or equal to `AcceptanceRangeLowValue` and lower than or equal to
189
+ * `AcceptanceRangeHighValue`.
190
+ *
191
+ * Neutral if the value is greater than or equal to `ToleranceRangeLowValue` and lower than `AcceptanceRangeLowValue`
192
+ * OR greater than `AcceptanceRangeHighValue` and lower than or equal to `ToleranceRangeHighValue`.
193
+ *
194
+ * Critical if the value is greater than or equal to `DeviationRangeLowValue` and lower than `ToleranceRangeLowValue`
195
+ * OR greater than `ToleranceRangeHighValue` and lower than or equal to `DeviationRangeHighValue`.
196
+ *
197
+ * Negative if the value is lower than `DeviationRangeLowValue` or greater than `DeviationRangeHighValue`.
198
+ */
199
+ Target = "Target",
200
+ }
201
+ }
202
+ }
203
+
204
+ declare module "sap/chart/AutoScaleMode" {
205
+ /**
206
+ * Enumeration for how the analytical chart adapts the value axis to the data.
207
+ */
208
+ enum AutoScaleMode {
209
+ /**
210
+ * Minimum and maximum value is calculated from the entire data set in the backend, no matter data can be
211
+ * loaded or not, visible or not.
212
+ */
213
+ DataSet = "DataSet",
214
+ /**
215
+ * Minimum and maximum value is calculated from the data that are currently visible. Scrolling will change
216
+ * the scale.
217
+ */
218
+ VisibleData = "VisibleData",
219
+ }
220
+ export default AutoScaleMode;
221
+ }
222
+
223
+ declare module "sap/chart/Chart" {
224
+ import {
225
+ default as BaseControl,
226
+ $BaseControlSettings,
227
+ } from "sap/viz/ui5/controls/common/BaseControl";
228
+
229
+ import Dimension from "sap/chart/data/Dimension";
230
+
231
+ import TimeDimension from "sap/chart/data/TimeDimension";
232
+
233
+ import Measure from "sap/chart/data/Measure";
234
+
235
+ import Event from "sap/ui/base/Event";
236
+
237
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
238
+
239
+ import { SelectionBehavior, SelectionMode } from "sap/chart/library";
240
+
241
+ import {
242
+ PropertyBindingInfo,
243
+ AggregationBindingInfo,
244
+ } from "sap/ui/base/ManagedObject";
245
+
246
+ import UI5Element from "sap/ui/core/Element";
247
+
248
+ /**
249
+ * @SINCE 1.32.0
250
+ *
251
+ * UI5 Chart control
252
+ */
253
+ export default class Chart extends BaseControl {
254
+ /**
255
+ * Constructor for a new Chart.
256
+ *
257
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
258
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
259
+ * of the syntax of the settings object.
260
+ */
261
+ constructor(
262
+ /**
263
+ * initial settings for the new control
264
+ */
265
+ mSettings?: $ChartSettings
266
+ );
267
+ /**
268
+ * Constructor for a new Chart.
269
+ *
270
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
271
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
272
+ * of the syntax of the settings object.
273
+ */
274
+ constructor(
275
+ /**
276
+ * id for the new control, generated automatically if no id is given
277
+ */
278
+ sId?: string,
279
+ /**
280
+ * initial settings for the new control
281
+ */
282
+ mSettings?: $ChartSettings
283
+ );
284
+
285
+ /**
286
+ * Creates a new subclass of class sap.chart.Chart with name `sClassName` and enriches it with the information
287
+ * contained in `oClassInfo`.
288
+ *
289
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.viz.ui5.controls.common.BaseControl.extend}.
290
+ *
291
+ * @returns Created class / constructor function
292
+ */
293
+ static extend<T extends Record<string, unknown>>(
294
+ /**
295
+ * Name of the class being created
296
+ */
297
+ sClassName: string,
298
+ /**
299
+ * Object literal with information about the class
300
+ */
301
+ oClassInfo?: sap.ClassInfo<T, Chart>,
302
+ /**
303
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
304
+ * used by this class
305
+ */
306
+ FNMetaImpl?: Function
307
+ ): Function;
308
+ /**
309
+ * Returns a metadata object for class sap.chart.Chart.
310
+ *
311
+ * @returns Metadata object describing this class
312
+ */
313
+ static getMetadata(): ElementMetadata;
314
+ /**
315
+ * Unsupported. Chart manages the "data" aggregation only via data binding. The method "addData" therefore
316
+ * cannot be used programmatically!
317
+ */
318
+ addData(): void;
319
+ /**
320
+ * Adds some dimension to the aggregation dimensions.
321
+ *
322
+ * Render a chart with time axis when the dimension type is {@link sap.chart.data.TimeDimension}. Please
323
+ * be advised that time axis is supported with limited chart types (column, line, combination, stacked_column,
324
+ * bubble, scatter, dual_combination, vertical_bullet, waterfall).
325
+ *
326
+ * @returns Reference to this in order to allow method chaining
327
+ */
328
+ addDimension(
329
+ /**
330
+ * The dimension to add; if empty, nothing is inserted
331
+ */
332
+ oDimension: Dimension | TimeDimension
333
+ ): this;
334
+ /**
335
+ * Adds some measure to the aggregation {@link #getMeasures measures}.
336
+ *
337
+ * @returns Reference to `this` in order to allow method chaining
338
+ */
339
+ addMeasure(
340
+ /**
341
+ * The measure to add; if empty, nothing is inserted
342
+ */
343
+ oMeasure: Measure
344
+ ): this;
345
+ /**
346
+ * Add one or more categories to current category selections, specified by category objects.
347
+ *
348
+ * Category object has the following structure:
349
+ * ```javascript
350
+ *
351
+ * {
352
+ * measure: measureName,
353
+ * dimensions: {
354
+ * dimensionName1: dimensionValue1,
355
+ * dimensionName2: dimensionValue2,
356
+ * ...
357
+ * }
358
+ * }
359
+ * ```
360
+ *
361
+ *
362
+ * Only works when selectionBehavior is "CATEGORY"
363
+ *
364
+ * @returns Reference to `this` in order to allow method chaining
365
+ */
366
+ addSelectedCategories(
367
+ /**
368
+ * an array of category objects
369
+ */
370
+ aCategories: any[]
371
+ ): this;
372
+ /**
373
+ * Add one or more data points to current data point selection, specified by datapoint objects.
374
+ *
375
+ * Datapoint object has the following structure:
376
+ * ```javascript
377
+ *
378
+ * {
379
+ * groupId: "groupId", // group ID (optional)
380
+ * index: index, // index of the data in the group
381
+ * measures: ["measureId"] // measure IDs
382
+ * }
383
+ * ```
384
+ *
385
+ *
386
+ * Only works when selectionBehavior is "DATAPOINT"
387
+ *
388
+ * @returns Reference to `this` in order to allow method chaining
389
+ */
390
+ addSelectedDataPoints(
391
+ /**
392
+ * an array of datapoint objects.
393
+ */
394
+ aDataPoints: any[]
395
+ ): this;
396
+ /**
397
+ * Add one or more series to current series selections, specified by series objects.
398
+ *
399
+ * Series object has the following structure:
400
+ * ```javascript
401
+ *
402
+ * {
403
+ * measure: measureName,
404
+ * dimensions: {
405
+ * dimensionName1: dimensionValue1,
406
+ * dimensionName2: dimensionValue2,
407
+ * ...
408
+ * }
409
+ * }
410
+ * ```
411
+ *
412
+ *
413
+ * Only works when selectionBehavior is "SERIES"
414
+ *
415
+ * @returns Reference to `this` in order to allow method chaining
416
+ */
417
+ addSelectedSeries(
418
+ /**
419
+ * an array of series objects
420
+ */
421
+ aSeries: any[]
422
+ ): this;
423
+ /**
424
+ * Attaches event handler `fnFunction` to the {@link #event:deselectData deselectData} event of this `sap.chart.Chart`.
425
+ *
426
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
427
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
428
+ *
429
+ * Event fires when certain data point(s) is(are) deselected, data context of deselected item(s) would be
430
+ * passed in
431
+ *
432
+ * @returns Reference to `this` in order to allow method chaining
433
+ */
434
+ attachDeselectData(
435
+ /**
436
+ * An application-specific payload object that will be passed to the event handler along with the event
437
+ * object when firing the event
438
+ */
439
+ oData: object,
440
+ /**
441
+ * The function to be called when the event occurs
442
+ */
443
+ fnFunction: (p1: Event) => void,
444
+ /**
445
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
446
+ */
447
+ oListener?: object
448
+ ): this;
449
+ /**
450
+ * Attaches event handler `fnFunction` to the {@link #event:deselectData deselectData} event of this `sap.chart.Chart`.
451
+ *
452
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
453
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
454
+ *
455
+ * Event fires when certain data point(s) is(are) deselected, data context of deselected item(s) would be
456
+ * passed in
457
+ *
458
+ * @returns Reference to `this` in order to allow method chaining
459
+ */
460
+ attachDeselectData(
461
+ /**
462
+ * The function to be called when the event occurs
463
+ */
464
+ fnFunction: (p1: Event) => void,
465
+ /**
466
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
467
+ */
468
+ oListener?: object
469
+ ): this;
470
+ /**
471
+ * Attaches event handler `fnFunction` to the {@link #event:drilledDown drilledDown} event of this `sap.chart.Chart`.
472
+ *
473
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
474
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
475
+ *
476
+ * fired after a drill-down operation
477
+ *
478
+ * @returns Reference to `this` in order to allow method chaining
479
+ */
480
+ attachDrilledDown(
481
+ /**
482
+ * An application-specific payload object that will be passed to the event handler along with the event
483
+ * object when firing the event
484
+ */
485
+ oData: object,
486
+ /**
487
+ * The function to be called when the event occurs
488
+ */
489
+ fnFunction: (p1: Event) => void,
490
+ /**
491
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
492
+ */
493
+ oListener?: object
494
+ ): this;
495
+ /**
496
+ * Attaches event handler `fnFunction` to the {@link #event:drilledDown drilledDown} event of this `sap.chart.Chart`.
497
+ *
498
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
499
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
500
+ *
501
+ * fired after a drill-down operation
502
+ *
503
+ * @returns Reference to `this` in order to allow method chaining
504
+ */
505
+ attachDrilledDown(
506
+ /**
507
+ * The function to be called when the event occurs
508
+ */
509
+ fnFunction: (p1: Event) => void,
510
+ /**
511
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
512
+ */
513
+ oListener?: object
514
+ ): this;
515
+ /**
516
+ * Attaches event handler `fnFunction` to the {@link #event:drilledUp drilledUp} event of this `sap.chart.Chart`.
517
+ *
518
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
519
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
520
+ *
521
+ * fired after a drill-up operation
522
+ *
523
+ * @returns Reference to `this` in order to allow method chaining
524
+ */
525
+ attachDrilledUp(
526
+ /**
527
+ * An application-specific payload object that will be passed to the event handler along with the event
528
+ * object when firing the event
529
+ */
530
+ oData: object,
531
+ /**
532
+ * The function to be called when the event occurs
533
+ */
534
+ fnFunction: (p1: Event) => void,
535
+ /**
536
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
537
+ */
538
+ oListener?: object
539
+ ): this;
540
+ /**
541
+ * Attaches event handler `fnFunction` to the {@link #event:drilledUp drilledUp} event of this `sap.chart.Chart`.
542
+ *
543
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
544
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
545
+ *
546
+ * fired after a drill-up operation
547
+ *
548
+ * @returns Reference to `this` in order to allow method chaining
549
+ */
550
+ attachDrilledUp(
551
+ /**
552
+ * The function to be called when the event occurs
553
+ */
554
+ fnFunction: (p1: Event) => void,
555
+ /**
556
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
557
+ */
558
+ oListener?: object
559
+ ): this;
560
+ /**
561
+ * Attaches event handler `fnFunction` to the {@link #event:drillStackChanged drillStackChanged} event of
562
+ * this `sap.chart.Chart`.
563
+ *
564
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
565
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
566
+ *
567
+ * Event fires when drill stack changed. API that relies on drill stack like {@link #drillDown}, {@link
568
+ * #drillUp} shall be called in this event or after chart is rendered
569
+ *
570
+ * @returns Reference to `this` in order to allow method chaining
571
+ */
572
+ attachDrillStackChanged(
573
+ /**
574
+ * An application-specific payload object that will be passed to the event handler along with the event
575
+ * object when firing the event
576
+ */
577
+ oData: object,
578
+ /**
579
+ * The function to be called when the event occurs
580
+ */
581
+ fnFunction: (p1: Event) => void,
582
+ /**
583
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
584
+ */
585
+ oListener?: object
586
+ ): this;
587
+ /**
588
+ * Attaches event handler `fnFunction` to the {@link #event:drillStackChanged drillStackChanged} event of
589
+ * this `sap.chart.Chart`.
590
+ *
591
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
592
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
593
+ *
594
+ * Event fires when drill stack changed. API that relies on drill stack like {@link #drillDown}, {@link
595
+ * #drillUp} shall be called in this event or after chart is rendered
596
+ *
597
+ * @returns Reference to `this` in order to allow method chaining
598
+ */
599
+ attachDrillStackChanged(
600
+ /**
601
+ * The function to be called when the event occurs
602
+ */
603
+ fnFunction: (p1: Event) => void,
604
+ /**
605
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
606
+ */
607
+ oListener?: object
608
+ ): this;
609
+ /**
610
+ * Attaches event handler `fnFunction` to the {@link #event:renderComplete renderComplete} event of this
611
+ * `sap.chart.Chart`.
612
+ *
613
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
614
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
615
+ *
616
+ * Event fires when the rendering ends.
617
+ *
618
+ * @returns Reference to `this` in order to allow method chaining
619
+ */
620
+ attachRenderComplete(
621
+ /**
622
+ * An application-specific payload object that will be passed to the event handler along with the event
623
+ * object when firing the event
624
+ */
625
+ oData: object,
626
+ /**
627
+ * The function to be called when the event occurs
628
+ */
629
+ fnFunction: (p1: Event) => void,
630
+ /**
631
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
632
+ */
633
+ oListener?: object
634
+ ): this;
635
+ /**
636
+ * Attaches event handler `fnFunction` to the {@link #event:renderComplete renderComplete} event of this
637
+ * `sap.chart.Chart`.
638
+ *
639
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
640
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
641
+ *
642
+ * Event fires when the rendering ends.
643
+ *
644
+ * @returns Reference to `this` in order to allow method chaining
645
+ */
646
+ attachRenderComplete(
647
+ /**
648
+ * The function to be called when the event occurs
649
+ */
650
+ fnFunction: (p1: Event) => void,
651
+ /**
652
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
653
+ */
654
+ oListener?: object
655
+ ): this;
656
+ /**
657
+ * Attaches event handler `fnFunction` to the {@link #event:selectData selectData} event of this `sap.chart.Chart`.
658
+ *
659
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
660
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
661
+ *
662
+ * Event fires when certain data point(s) is(are) selected, data context of selected item(s) would be passed
663
+ * in.
664
+ *
665
+ * @returns Reference to `this` in order to allow method chaining
666
+ */
667
+ attachSelectData(
668
+ /**
669
+ * An application-specific payload object that will be passed to the event handler along with the event
670
+ * object when firing the event
671
+ */
672
+ oData: object,
673
+ /**
674
+ * The function to be called when the event occurs
675
+ */
676
+ fnFunction: (p1: Event) => void,
677
+ /**
678
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
679
+ */
680
+ oListener?: object
681
+ ): this;
682
+ /**
683
+ * Attaches event handler `fnFunction` to the {@link #event:selectData selectData} event of this `sap.chart.Chart`.
684
+ *
685
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
686
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
687
+ *
688
+ * Event fires when certain data point(s) is(are) selected, data context of selected item(s) would be passed
689
+ * in.
690
+ *
691
+ * @returns Reference to `this` in order to allow method chaining
692
+ */
693
+ attachSelectData(
694
+ /**
695
+ * The function to be called when the event occurs
696
+ */
697
+ fnFunction: (p1: Event) => void,
698
+ /**
699
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
700
+ */
701
+ oListener?: object
702
+ ): this;
703
+ /**
704
+ * Attaches event handler `fnFunction` to the {@link #event:valueAxisFixedScaleTurnedOff valueAxisFixedScaleTurnedOff}
705
+ * event of this `sap.chart.Chart`.
706
+ *
707
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
708
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
709
+ *
710
+ * Event fires when fixed scale is turned off by adding or removing dimension
711
+ *
712
+ * @returns Reference to `this` in order to allow method chaining
713
+ */
714
+ attachValueAxisFixedScaleTurnedOff(
715
+ /**
716
+ * An application-specific payload object that will be passed to the event handler along with the event
717
+ * object when firing the event
718
+ */
719
+ oData: object,
720
+ /**
721
+ * The function to be called when the event occurs
722
+ */
723
+ fnFunction: (p1: Event) => void,
724
+ /**
725
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
726
+ */
727
+ oListener?: object
728
+ ): this;
729
+ /**
730
+ * Attaches event handler `fnFunction` to the {@link #event:valueAxisFixedScaleTurnedOff valueAxisFixedScaleTurnedOff}
731
+ * event of this `sap.chart.Chart`.
732
+ *
733
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
734
+ * otherwise it will be bound to this `sap.chart.Chart` itself.
735
+ *
736
+ * Event fires when fixed scale is turned off by adding or removing dimension
737
+ *
738
+ * @returns Reference to `this` in order to allow method chaining
739
+ */
740
+ attachValueAxisFixedScaleTurnedOff(
741
+ /**
742
+ * The function to be called when the event occurs
743
+ */
744
+ fnFunction: (p1: Event) => void,
745
+ /**
746
+ * Context object to call the event handler with. Defaults to this `sap.chart.Chart` itself
747
+ */
748
+ oListener?: object
749
+ ): this;
750
+ /**
751
+ * Binds aggregation {@link #getData data} to model data.
752
+ *
753
+ * See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
754
+ * of the possible properties of `oBindingInfo`.
755
+ *
756
+ * **NOTE:** If the {@link sap.ui.model.odata.v4.ODataListBinding list binding} is suspended, data related
757
+ * requests in Chart will be impacted, and the corresponding operations might not work as expected.
758
+ *
759
+ * @returns Reference to `this` in order to allow method chaining
760
+ */
761
+ bindData(
762
+ /**
763
+ * The binding information
764
+ */
765
+ oBindingInfo: object
766
+ ): this;
767
+ /**
768
+ * Unsupported. Chart manages the "data" aggregation only via data binding. The method "destroyData" therefore
769
+ * cannot be used programmatically!
770
+ */
771
+ destroyData(): void;
772
+ /**
773
+ * Destroys all the dimensions in the aggregation dimensions, only works when the property isAnalytical
774
+ * is true.
775
+ *
776
+ * @returns Reference to this in order to allow method chaining
777
+ */
778
+ destroyDimensions(): this;
779
+ /**
780
+ * Destroys all the measures in the aggregation {@link #getMeasures measures}.
781
+ *
782
+ * @returns Reference to `this` in order to allow method chaining
783
+ */
784
+ destroyMeasures(): this;
785
+ /**
786
+ * Detaches event handler `fnFunction` from the {@link #event:deselectData deselectData} event of this `sap.chart.Chart`.
787
+ *
788
+ * The passed function and listener object must match the ones used for event registration.
789
+ *
790
+ * @returns Reference to `this` in order to allow method chaining
791
+ */
792
+ detachDeselectData(
793
+ /**
794
+ * The function to be called, when the event occurs
795
+ */
796
+ fnFunction: (p1: Event) => void,
797
+ /**
798
+ * Context object on which the given function had to be called
799
+ */
800
+ oListener?: object
801
+ ): this;
802
+ /**
803
+ * Detaches event handler `fnFunction` from the {@link #event:drilledDown drilledDown} event of this `sap.chart.Chart`.
804
+ *
805
+ * The passed function and listener object must match the ones used for event registration.
806
+ *
807
+ * @returns Reference to `this` in order to allow method chaining
808
+ */
809
+ detachDrilledDown(
810
+ /**
811
+ * The function to be called, when the event occurs
812
+ */
813
+ fnFunction: (p1: Event) => void,
814
+ /**
815
+ * Context object on which the given function had to be called
816
+ */
817
+ oListener?: object
818
+ ): this;
819
+ /**
820
+ * Detaches event handler `fnFunction` from the {@link #event:drilledUp drilledUp} event of this `sap.chart.Chart`.
821
+ *
822
+ * The passed function and listener object must match the ones used for event registration.
823
+ *
824
+ * @returns Reference to `this` in order to allow method chaining
825
+ */
826
+ detachDrilledUp(
827
+ /**
828
+ * The function to be called, when the event occurs
829
+ */
830
+ fnFunction: (p1: Event) => void,
831
+ /**
832
+ * Context object on which the given function had to be called
833
+ */
834
+ oListener?: object
835
+ ): this;
836
+ /**
837
+ * Detaches event handler `fnFunction` from the {@link #event:drillStackChanged drillStackChanged} event
838
+ * of this `sap.chart.Chart`.
839
+ *
840
+ * The passed function and listener object must match the ones used for event registration.
841
+ *
842
+ * @returns Reference to `this` in order to allow method chaining
843
+ */
844
+ detachDrillStackChanged(
845
+ /**
846
+ * The function to be called, when the event occurs
847
+ */
848
+ fnFunction: (p1: Event) => void,
849
+ /**
850
+ * Context object on which the given function had to be called
851
+ */
852
+ oListener?: object
853
+ ): this;
854
+ /**
855
+ * Detaches event handler `fnFunction` from the {@link #event:renderComplete renderComplete} event of this
856
+ * `sap.chart.Chart`.
857
+ *
858
+ * The passed function and listener object must match the ones used for event registration.
859
+ *
860
+ * @returns Reference to `this` in order to allow method chaining
861
+ */
862
+ detachRenderComplete(
863
+ /**
864
+ * The function to be called, when the event occurs
865
+ */
866
+ fnFunction: (p1: Event) => void,
867
+ /**
868
+ * Context object on which the given function had to be called
869
+ */
870
+ oListener?: object
871
+ ): this;
872
+ /**
873
+ * Detaches event handler `fnFunction` from the {@link #event:selectData selectData} event of this `sap.chart.Chart`.
874
+ *
875
+ * The passed function and listener object must match the ones used for event registration.
876
+ *
877
+ * @returns Reference to `this` in order to allow method chaining
878
+ */
879
+ detachSelectData(
880
+ /**
881
+ * The function to be called, when the event occurs
882
+ */
883
+ fnFunction: (p1: Event) => void,
884
+ /**
885
+ * Context object on which the given function had to be called
886
+ */
887
+ oListener?: object
888
+ ): this;
889
+ /**
890
+ * Detaches event handler `fnFunction` from the {@link #event:valueAxisFixedScaleTurnedOff valueAxisFixedScaleTurnedOff}
891
+ * event of this `sap.chart.Chart`.
892
+ *
893
+ * The passed function and listener object must match the ones used for event registration.
894
+ *
895
+ * @returns Reference to `this` in order to allow method chaining
896
+ */
897
+ detachValueAxisFixedScaleTurnedOff(
898
+ /**
899
+ * The function to be called, when the event occurs
900
+ */
901
+ fnFunction: (p1: Event) => void,
902
+ /**
903
+ * Context object on which the given function had to be called
904
+ */
905
+ oListener?: object
906
+ ): this;
907
+ /**
908
+ * Drill down on specific Dimension(s), only works when the property isAnalytical is true.
909
+ *
910
+ * The drill down Dimension(s) must present in the Dimension aggregation and must NOT present in previous
911
+ * drill down or be visible already.
912
+ *
913
+ * **NOTE:** parameter `oBindingInfo.length` during {@link sap.ui.base.ManagedObject#bindAggregation bindAggregation}
914
+ * of {@link #getData data} always takes effect in drill workflow.
915
+ */
916
+ drillDown(
917
+ /**
918
+ * an array, or just a single instance, of either Dimension instance or Dimension name to drill down
919
+ */
920
+ vDimensions: any[]
921
+ ): void;
922
+ /**
923
+ * Drill up to previous drill down state, only works when the property isAnalytical is true.
924
+ *
925
+ * **NOTE:** parameter `oBindingInfo.length` during {@link sap.ui.base.ManagedObject#bindAggregation bindAggregation}
926
+ * of {@link #getData data} always takes effect in drill workflow.
927
+ */
928
+ drillUp(
929
+ /**
930
+ * index of drill state in history to drill up. Default to the previous state in history if available.
931
+ */
932
+ iIndex: int
933
+ ): void;
934
+ /**
935
+ * Export the current chart as SVG String. The chart is ready to be exported to SVG ONLY after the initialization
936
+ * is finished. Any attempt to export to SVG before that will result in an empty SVG string.
937
+ *
938
+ * @returns the SVG string of the current viz or empty svg if error occurs.
939
+ */
940
+ exportToSVGString(
941
+ /**
942
+ *
943
+ * ```javascript
944
+ *
945
+ * {
946
+ * width: Number - the exported svg will be scaled to the specific width.
947
+ * height: Number - the exported svg will be scaled to the specific height.
948
+ * hideTitleLegend: Boolean - flag to indicate if the exported SVG includes the original title and legend.
949
+ * hideAxis: Boolean - flag to indicate if the exported SVG includes the original axis.
950
+ * }
951
+ * ```
952
+ */
953
+ option?: Object
954
+ ): string;
955
+ /**
956
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
957
+ *
958
+ * Fires event {@link #event:deselectData deselectData} to attached listeners.
959
+ *
960
+ * @returns Reference to `this` in order to allow method chaining
961
+ */
962
+ fireDeselectData(
963
+ /**
964
+ * Parameters to pass along with the event
965
+ */
966
+ mParameters?: object
967
+ ): this;
968
+ /**
969
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
970
+ *
971
+ * Fires event {@link #event:drilledDown drilledDown} to attached listeners.
972
+ *
973
+ * @returns Reference to `this` in order to allow method chaining
974
+ */
975
+ fireDrilledDown(
976
+ /**
977
+ * Parameters to pass along with the event
978
+ */
979
+ mParameters?: {
980
+ /**
981
+ * array of strings holding the names of the added dimensions
982
+ */
983
+ dimensions?: string[];
984
+ }
985
+ ): this;
986
+ /**
987
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
988
+ *
989
+ * Fires event {@link #event:drilledUp drilledUp} to attached listeners.
990
+ *
991
+ * @returns Reference to `this` in order to allow method chaining
992
+ */
993
+ fireDrilledUp(
994
+ /**
995
+ * Parameters to pass along with the event
996
+ */
997
+ mParameters?: {
998
+ /**
999
+ * array of strings holding the names of the removed dimensions
1000
+ */
1001
+ dimensions?: string[];
1002
+ }
1003
+ ): this;
1004
+ /**
1005
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1006
+ *
1007
+ * Fires event {@link #event:drillStackChanged drillStackChanged} to attached listeners.
1008
+ *
1009
+ * @returns Reference to `this` in order to allow method chaining
1010
+ */
1011
+ fireDrillStackChanged(
1012
+ /**
1013
+ * Parameters to pass along with the event
1014
+ */
1015
+ mParameters?: object
1016
+ ): this;
1017
+ /**
1018
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1019
+ *
1020
+ * Fires event {@link #event:renderComplete renderComplete} to attached listeners.
1021
+ *
1022
+ * @returns Reference to `this` in order to allow method chaining
1023
+ */
1024
+ fireRenderComplete(
1025
+ /**
1026
+ * Parameters to pass along with the event
1027
+ */
1028
+ mParameters?: object
1029
+ ): this;
1030
+ /**
1031
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1032
+ *
1033
+ * Fires event {@link #event:selectData selectData} to attached listeners.
1034
+ *
1035
+ * @returns Reference to `this` in order to allow method chaining
1036
+ */
1037
+ fireSelectData(
1038
+ /**
1039
+ * Parameters to pass along with the event
1040
+ */
1041
+ mParameters?: object
1042
+ ): this;
1043
+ /**
1044
+ * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
1045
+ *
1046
+ * Fires event {@link #event:valueAxisFixedScaleTurnedOff valueAxisFixedScaleTurnedOff} to attached listeners.
1047
+ *
1048
+ * @returns Reference to `this` in order to allow method chaining
1049
+ */
1050
+ fireValueAxisFixedScaleTurnedOff(
1051
+ /**
1052
+ * Parameters to pass along with the event
1053
+ */
1054
+ mParameters?: object
1055
+ ): this;
1056
+ /**
1057
+ * Gets current value of property {@link #getActiveColoring activeColoring}.
1058
+ *
1059
+ * Active coloring configurations.
1060
+ *
1061
+ * specifies which coloring of the possible colorings is to be applied for the current chart layout. It
1062
+ * holds an object with two properties:
1063
+ *
1064
+ *
1065
+ * - coloring: **mandatory**, specify which kind of coloring should take effect in current chart layout.
1066
+ * Possible values refer to {@link sap.chart.ColoringType} parameters:
1067
+ * `Criticality` supports two parameters: `"dimension"` and `"measure"`. Both are **optional**, one (and
1068
+ * only one) must be provided. This setting disambiguates when multiple colorings for different visible
1069
+ * dimensions and measures are applicable.
1070
+ *
1071
+ * `"measure"` supports two input types:
1072
+ * - `string` for single measure name
1073
+ * - `string[]` of multiple measure names(only supported in **static**), which is relevant in case of
1074
+ * a **static** measure criticality defined on multiple measures. `"dimension"` holds the dimension
1075
+ * name as string value. `Emphasis` supports only one parameter: `"dimension"` which is **optional**.
1076
+ *
1077
+ * `"dimension"` holds the dimension name as string value.
1078
+ *
1079
+ * Example:
1080
+ * ```javascript
1081
+ *
1082
+ * activeColoring: {
1083
+ * coloring: sap.chart.ColoringType.Criticality,
1084
+ * parameters: {
1085
+ * dimension: "AvailabilityStatus”
1086
+ * }
1087
+ * }
1088
+ * ```
1089
+ *
1090
+ *
1091
+ * @returns Value of property `activeColoring`
1092
+ */
1093
+ getActiveColoring(): object;
1094
+ /**
1095
+ * Returns available and unavailable chart types with current Dimensions and Measures. An error info will
1096
+ * be returned along with each unavailable chart types.
1097
+ *
1098
+ *
1099
+ * ```javascript
1100
+ *
1101
+ * {
1102
+ * available: [{
1103
+ * chart: "chartType"
1104
+ * }, ...],
1105
+ * unavailable: [{
1106
+ * chart: "chartType"
1107
+ * error: {
1108
+ * missing: {
1109
+ * Dimension: n,
1110
+ * Measure: n,
1111
+ * DateTimeDimension: n
1112
+ * }
1113
+ * }
1114
+ * }, ...]
1115
+ * }
1116
+ * ```
1117
+ *
1118
+ *
1119
+ * @returns chart types and errors for unavailable chart types, grouped by availability
1120
+ */
1121
+ getAvailableChartTypes(): object;
1122
+ /**
1123
+ * Gets current value of property {@link #getChartType chartType}.
1124
+ *
1125
+ * Type of the Chart.
1126
+ *
1127
+ * Default value is `"bar"`.
1128
+ *
1129
+ * @returns Value of property `chartType`
1130
+ */
1131
+ getChartType(): string;
1132
+ /**
1133
+ * Gets current value of property {@link #getColorings colorings}.
1134
+ *
1135
+ * Chart colorings.
1136
+ *
1137
+ * Holds an object with information about the possible options how colors can be applied for indicating
1138
+ * `Criticality` or `Emphasis` in the chart.
1139
+ * ```javascript
1140
+ *
1141
+ * Colorings: {
1142
+ * Criticality: {
1143
+ * …
1144
+ * },
1145
+ * Emphasis: {
1146
+ * …
1147
+ * }
1148
+ * }
1149
+ * ```
1150
+ *
1151
+ *
1152
+ * **NOTE:** Dimension-based coloring does not work when {@link sap.chart.data.Measure#setSemantics} is
1153
+ * set to {@link sap.chart.data.MeasureSemantics.Projected} or {@link sap.chart.data.MeasureSemantics.Reference}
1154
+ * for visible measure(s).
1155
+ *
1156
+ * Refer to
1157
+ * {@link sap.chart.ColoringType.Criticality}
1158
+ * {@link sap.chart.ColoringType.Emphasis}
1159
+ * for detailed usage
1160
+ *
1161
+ * @returns Value of property `colorings`
1162
+ */
1163
+ getColorings(): object;
1164
+ /**
1165
+ * Gets current value of property {@link #getCustomMessages customMessages}.
1166
+ *
1167
+ * Chart custom messages.
1168
+ *
1169
+ * @returns Value of property `customMessages`
1170
+ */
1171
+ getCustomMessages(): object;
1172
+ /**
1173
+ * Unsupported. Chart manages the "data" aggregation only via data binding. The method "getData" therefore
1174
+ * cannot be used programmatically!
1175
+ */
1176
+ getData(): void;
1177
+ /**
1178
+ * Return Dimension with the given name.
1179
+ *
1180
+ * @returns Dimension of the specified name.
1181
+ */
1182
+ getDimensionByName(
1183
+ /**
1184
+ * name of the Dimension to get
1185
+ */
1186
+ sName: string
1187
+ ): Dimension;
1188
+ /**
1189
+ * Gets content of aggregation {@link #getDimensions dimensions}.
1190
+ *
1191
+ * Dimensions of the data.
1192
+ */
1193
+ getDimensions(): Dimension[];
1194
+ /**
1195
+ * Return all drill down states, only works when the property isAnalytical is true.
1196
+ *
1197
+ * NOTE: If {@link sap.chart.data.HierarchyDimension} is used when calling {@link #setVisibleDimensions},
1198
+ * drill stack could not be determined synchronously. Listen to `drillStackChanged` event instead.
1199
+ *
1200
+ * @returns array of drill state objects
1201
+ */
1202
+ getDrillStack(): Object[];
1203
+ /**
1204
+ * Gets current value of property {@link #getEnablePagination enablePagination}.
1205
+ *
1206
+ * Enable pagination mode.
1207
+ *
1208
+ * Pagination mode empowers users to visualize dataset page by page by scrolling back or forth. Currently
1209
+ * there are some restrictions of this mode in some chart transversal features, such as:
1210
+ * - Selection status might lost for new batch data
1211
+ * - Keyboard navigation will be only available for current continuous batch data
1212
+ * - Zoom out might have inconsistent behavior, Hence the gesture in mobile might have the same issue
1213
+ *
1214
+ * - Time charts did not enable pagination yet
1215
+ * - Series color might be inconsistent before/after jump pages
1216
+ * - OData V4 Model with relative binding is not supported in pagination Please refer to release
1217
+ * notes for details.
1218
+ *
1219
+ * Default value is `false`.
1220
+ *
1221
+ * @returns Value of property `enablePagination`
1222
+ */
1223
+ getEnablePagination(): boolean;
1224
+ /**
1225
+ * Gets current value of property {@link #getEnableScalingFactor enableScalingFactor}.
1226
+ *
1227
+ * Enable scaling factor.
1228
+ *
1229
+ * Default value is `false`.
1230
+ *
1231
+ * @returns Value of property `enableScalingFactor`
1232
+ */
1233
+ getEnableScalingFactor(): boolean;
1234
+ /**
1235
+ * Gets current value of property {@link #getEnableStableColor enableStableColor}.
1236
+ *
1237
+ * Enable Stable color mode. To keep the same colors for the same dimension values or measure names.
1238
+ *
1239
+ * Default value is `false`.
1240
+ *
1241
+ * @returns Value of property `enableStableColor`
1242
+ */
1243
+ getEnableStableColor(): boolean;
1244
+ /**
1245
+ * Gets current value of property {@link #getHideSharedInformation hideSharedInformation}.
1246
+ *
1247
+ * Hide shared dimensions from selected data points when you drill down. A dimension is hidden if all selected
1248
+ * data points share the same.
1249
+ *
1250
+ * Default value is `true`.
1251
+ *
1252
+ * @returns Value of property `hideSharedInformation`
1253
+ */
1254
+ getHideSharedInformation(): boolean;
1255
+ /**
1256
+ * Gets current value of property {@link #getInResultDimensions inResultDimensions}.
1257
+ *
1258
+ * Names of the inResult dimensions.
1259
+ *
1260
+ * inResult dimension do not show up in chart layout, i.e. axis/legend. They do show in tooltip, popover,
1261
+ * and in selection results.
1262
+ *
1263
+ * Default value is `[]`.
1264
+ *
1265
+ * @returns Value of property `inResultDimensions`
1266
+ */
1267
+ getInResultDimensions(): string[];
1268
+ /**
1269
+ * Gets current value of property isAnalytical.
1270
+ *
1271
+ * Whether or not an aggregated entity set is bound to the chart.
1272
+ *
1273
+ * The property isAnalytical will programmatically set according to data source. When the data source has
1274
+ * an aggregated entity set, isAnalytical is true, otherwise it's false.
1275
+ *
1276
+ * @returns Value of property isAnalytical
1277
+ */
1278
+ getIsAnalytical(): boolean;
1279
+ /**
1280
+ * Return Measure with the given name.
1281
+ *
1282
+ * @returns Measure of the specified name.
1283
+ */
1284
+ getMeasureByName(
1285
+ /**
1286
+ * name of the Measure to get
1287
+ */
1288
+ sName: string
1289
+ ): Measure;
1290
+ /**
1291
+ * Gets content of aggregation {@link #getMeasures measures}.
1292
+ *
1293
+ * Measures of the data.
1294
+ */
1295
+ getMeasures(): Measure[];
1296
+ /**
1297
+ * return the scaling factor. Or return null when scaling factor is disable.
1298
+ *
1299
+ * @returns A scaling factor object or null
1300
+ */
1301
+ getScalingFactor(): object;
1302
+ /**
1303
+ * Return category objects of currently selected categories and a total number of selected data points.
1304
+ *
1305
+ * Category object has the following structure:
1306
+ * ```javascript
1307
+ *
1308
+ * {
1309
+ * measure: measureName,
1310
+ * dimensions: {
1311
+ * dimensionName1: dimensionValue1,
1312
+ * dimensionName2: dimensionValue2,
1313
+ * ...
1314
+ * }
1315
+ * }
1316
+ * ```
1317
+ *
1318
+ *
1319
+ * Return 0 and empty list if selectionBehavior is not "CATEGORY"
1320
+ *
1321
+ * @returns a total number of selected data points, and an array of category objects for selected categories.
1322
+ */
1323
+ getSelectedCategories(): object;
1324
+ /**
1325
+ * Return a total number and an array of datapoint objects (including a Context object) of currently selected
1326
+ * data points.
1327
+ *
1328
+ * Datapoint object has the following structure:
1329
+ * ```javascript
1330
+ *
1331
+ * {
1332
+ * index: index, // index of the data in the group
1333
+ * measures: ["measureId"] // measure IDs (data points created from the same Context object
1334
+ * // differing only in measure names are merged together)
1335
+ * context: [Context] // Context object
1336
+ * unit: {
1337
+ * measureId : "" // unit of measure
1338
+ * }
1339
+ * dataName: {
1340
+ * measureId or dimensionId : "" // dataName of measure or dimension
1341
+ * }
1342
+ * }
1343
+ * ```
1344
+ *
1345
+ *
1346
+ * Only works when selectionBehavior is "DATAPOINT"
1347
+ *
1348
+ * @returns a total number of selected data points, and an array of datapoint objects.
1349
+ */
1350
+ getSelectedDataPoints(): object;
1351
+ /**
1352
+ * Return series objects of currently selected series and a total number of selected data points.
1353
+ *
1354
+ * Series object has the following structure:
1355
+ * ```javascript
1356
+ *
1357
+ * {
1358
+ * measure: measureName,
1359
+ * dimensions: {
1360
+ * dimensionName1: dimensionValue1,
1361
+ * dimensionName2: dimensionValue2,
1362
+ * ...
1363
+ * }
1364
+ * }
1365
+ * ```
1366
+ *
1367
+ *
1368
+ * Return 0 and empty list if selectionBehavior is not "SERIES"
1369
+ *
1370
+ * @returns object containing a total number of selected data points, and an array of series objects for
1371
+ * selected series.
1372
+ */
1373
+ getSelectedSeries(): object;
1374
+ /**
1375
+ * Gets current value of property {@link #getSelectionBehavior selectionBehavior}.
1376
+ *
1377
+ * Chart selection behavior.
1378
+ *
1379
+ * Default value is `DataPoint`.
1380
+ *
1381
+ * @returns Value of property `selectionBehavior`
1382
+ */
1383
+ getSelectionBehavior(): SelectionBehavior;
1384
+ /**
1385
+ * Gets current value of property {@link #getSelectionMode selectionMode}.
1386
+ *
1387
+ * Chart selection mode.
1388
+ *
1389
+ * Default value is `Multi`.
1390
+ *
1391
+ * @returns Value of property `selectionMode`
1392
+ */
1393
+ getSelectionMode(): SelectionMode;
1394
+ /**
1395
+ * Return all TimeDimensions from current Dimensions.
1396
+ *
1397
+ * @returns Dimensions which are instance of TimeDimension.
1398
+ */
1399
+ getTimeDimensions(): any[];
1400
+ /**
1401
+ * Gets current value of property {@link #getUiConfig uiConfig}.
1402
+ *
1403
+ * Configuration for initialization to VizControl. This property could only set via settings parameter in
1404
+ * Constructor.
1405
+ *
1406
+ * @returns Value of property `uiConfig`
1407
+ */
1408
+ getUiConfig(): object;
1409
+ /**
1410
+ * Gets current value of property {@link #getValueAxisScale valueAxisScale}.
1411
+ *
1412
+ * Value Axis Scale.
1413
+ *
1414
+ * Specifies the scale of the chart value axes.
1415
+ *
1416
+ *
1417
+ * - scaleBehavior: **optional**, determines whether or not all value axes in the chart should have a
1418
+ * fixed scale. Possible values refer to {@link sap.chart.ScaleBehavior}. The default value is sap.chart.ScaleBehavior.AutoScale.
1419
+ * In order to apply a fixed scale, boundary values for minimum and maximum must have been specified for
1420
+ * all visible measures, and the axes boundaries are then created from the largest maximum and the smallest
1421
+ * minimum value of the measures put on the respective axis. If any visible measure lacks this information,
1422
+ * or scaleBehavior is set to sap.chart.ScaleBehavior.AutoScale, the chart will apply an automatic scaling
1423
+ * for all value axes.
1424
+ * - fixedScaleSettings:
1425
+ * measureBoundaryValues: An object holding the fixed “minimum” and “maximum” values for all the measures.
1426
+ * Stacked chart with only one measure also uses this object to describe the fixed “minimum” and “maximum”
1427
+ * value.
1428
+ * `measure` Measure name
1429
+ * - stackedMultipleMeasureBoundaryValues: An array of objects holding the fixed “minimum” and “maximum”
1430
+ * values only for stacked chart with multiple measures.
1431
+ * `measures` the array of measure name applied to the axis.
1432
+ * - `boundaryValues:` An object holding the fixed “minimum” and “maximum” value all the measures applied
1433
+ * to certain axis.
1434
+ * - autoScaleSettings:
1435
+ * `zeroAlwaysVisible` forces the value axis to always display the zero value (only a few chart types
1436
+ * support the opposite), which is **optional**. The default value is true.
1437
+ * - `syncWith` selects how the chart adapts the value axis to the data: The axis boundaries may be determined
1438
+ * from the loaded data, which is **optional**. The default value is "DataSet". Possible values refer to
1439
+ * {@link sap.chart.AutoScaleMode}.
1440
+ *
1441
+ * Example:
1442
+ * ```javascript
1443
+ *
1444
+ * valueAxisScale: {
1445
+ * scaleBehavior: sap.chart.ScaleBehavior,
1446
+ * fixedScaleSettings: {
1447
+ * measureBoundaryValues: {
1448
+ * measure_1: {
1449
+ * minimum: Number,
1450
+ * maximum: Number
1451
+ * },
1452
+ * measure_2: {
1453
+ * minimum: Number,
1454
+ * maximum: Number
1455
+ * }
1456
+ * },
1457
+ * stackedMultipleMeasureBoundaryValues: [{
1458
+ * measures: [ 'measure_1', 'measure_2', … ],
1459
+ * boundaryValues: {
1460
+ * minimum: Number,
1461
+ * maximum: Number
1462
+ * }
1463
+ * }, {
1464
+ * measures: [ 'measure_3', 'measure_4', … ],
1465
+ * boundaryValues: {
1466
+ * minimum: Number,
1467
+ * maximum: Number
1468
+ * }
1469
+ * }]
1470
+ * },
1471
+ * autoScaleSettings: {
1472
+ * zeroAlwaysVisible: Boolean,
1473
+ * syncWith: sap.chart.autoScaleMode
1474
+ * }
1475
+ * }
1476
+ * ```
1477
+ *
1478
+ *
1479
+ * Refer to
1480
+ * {@link sap.chart.AutoScaleMode.DataSet}
1481
+ * {@link sap.chart.AutoScaleMode.VisibleData}
1482
+ * {@link sap.chart.ScaleBehavior.AutoScale}
1483
+ * {@link sap.chart.ScaleBehavior.FixedScale}
1484
+ * for detailed usage
1485
+ *
1486
+ * @returns Value of property `valueAxisScale`
1487
+ */
1488
+ getValueAxisScale(): object;
1489
+ /**
1490
+ * Gets current value of property {@link #getVisibleDimensions visibleDimensions}.
1491
+ *
1492
+ * Names of the Dimensions to be displayed in the Chart, all available dimensions will automatically append
1493
+ * when the property isAnalytical is false.
1494
+ *
1495
+ * Depending on chart type, insufficient number of visible `Dimension`s will cause error.
1496
+ *
1497
+ * Default value is `[]`.
1498
+ *
1499
+ * @returns Value of property `visibleDimensions`
1500
+ */
1501
+ getVisibleDimensions(): string[];
1502
+ /**
1503
+ * Gets current value of property {@link #getVisibleMeasures visibleMeasures}.
1504
+ *
1505
+ * Names of the Measures to be displayed in the Chart.
1506
+ *
1507
+ * Depending on chart type, insufficient number of visible `Measure`s will cause errors.
1508
+ *
1509
+ * Default value is `[]`.
1510
+ *
1511
+ * @returns Value of property `visibleMeasures`
1512
+ */
1513
+ getVisibleMeasures(): string[];
1514
+ /**
1515
+ * Return Chart's properties.
1516
+ *
1517
+ * Refer to chart property documentation for more
1518
+ * details.
1519
+ *
1520
+ * @returns the Chart properties object
1521
+ */
1522
+ getVizProperties(): object;
1523
+ /**
1524
+ * Return Chart's scales.
1525
+ *
1526
+ * Refer to chart property documentation for more
1527
+ * details.
1528
+ *
1529
+ * @returns an array of scale objects
1530
+ */
1531
+ getVizScales(): object[];
1532
+ /**
1533
+ * Get the UID for Chart. It supports other controls to connect to a viz instance.
1534
+ *
1535
+ * @returns Chart UID
1536
+ */
1537
+ getVizUid(): string;
1538
+ /**
1539
+ * @SINCE 1.54
1540
+ *
1541
+ * Get zoom information.
1542
+ *
1543
+ * Return the zooming enablement and current zooming level of chart.
1544
+ *
1545
+ * Object has the following structure:
1546
+ *
1547
+ * Example:
1548
+ * ```javascript
1549
+ *
1550
+ * {
1551
+ * "enabled":true,
1552
+ * "currentZoomLevel":0.16
1553
+ * }
1554
+ * ```
1555
+ *
1556
+ *
1557
+ * @returns The zooming enablement and current zooming level of chart.The zooming level is between 0 and
1558
+ * 1, and null when zooming isn't applicable.
1559
+ */
1560
+ getZoomInfo(): object;
1561
+ /**
1562
+ * Unsupported. Chart manages the "data" aggregation only via data binding. The method "indexOfData" therefore
1563
+ * cannot be used programmatically!
1564
+ */
1565
+ indexOfData(): void;
1566
+ /**
1567
+ * Checks for the provided `sap.chart.data.Dimension` in the aggregation {@link #getDimensions dimensions}.
1568
+ * and returns its index if found or -1 otherwise.
1569
+ *
1570
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1571
+ */
1572
+ indexOfDimension(
1573
+ /**
1574
+ * The dimension whose index is looked for
1575
+ */
1576
+ oDimension: Dimension
1577
+ ): int;
1578
+ /**
1579
+ * Checks for the provided `sap.chart.data.Measure` in the aggregation {@link #getMeasures measures}. and
1580
+ * returns its index if found or -1 otherwise.
1581
+ *
1582
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1583
+ */
1584
+ indexOfMeasure(
1585
+ /**
1586
+ * The measure whose index is looked for
1587
+ */
1588
+ oMeasure: Measure
1589
+ ): int;
1590
+ /**
1591
+ * Unsupported. Chart manages the "data" aggregation only via data binding. The method "insertData" therefore
1592
+ * cannot be used programmatically!
1593
+ */
1594
+ insertData(): void;
1595
+ /**
1596
+ * Inserts a dimension into the aggregation {@link #getDimensions dimensions}.
1597
+ *
1598
+ * @returns Reference to `this` in order to allow method chaining
1599
+ */
1600
+ insertDimension(
1601
+ /**
1602
+ * The dimension to insert; if empty, nothing is inserted
1603
+ */
1604
+ oDimension: Dimension,
1605
+ /**
1606
+ * The `0`-based index the dimension should be inserted at; for a negative value of `iIndex`, the dimension
1607
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the dimension
1608
+ * is inserted at the last position
1609
+ */
1610
+ iIndex: int
1611
+ ): this;
1612
+ /**
1613
+ * Inserts a measure into the aggregation {@link #getMeasures measures}.
1614
+ *
1615
+ * @returns Reference to `this` in order to allow method chaining
1616
+ */
1617
+ insertMeasure(
1618
+ /**
1619
+ * The measure to insert; if empty, nothing is inserted
1620
+ */
1621
+ oMeasure: Measure,
1622
+ /**
1623
+ * The `0`-based index the measure should be inserted at; for a negative value of `iIndex`, the measure
1624
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the measure
1625
+ * is inserted at the last position
1626
+ */
1627
+ iIndex: int
1628
+ ): this;
1629
+ /**
1630
+ * Unsupported. Chart manages the "data" aggregation only via data binding. The method "removeAllData" therefore
1631
+ * cannot be used programmatically!
1632
+ */
1633
+ removeAllData(): void;
1634
+ /**
1635
+ * Removes all the controls from the aggregation dimensions, only works when the property isAnalytical is
1636
+ * true.
1637
+ *
1638
+ * Additionally, it unregisters them from the hosting UIArea.
1639
+ *
1640
+ * @returns An array of the removed elements (might be empty)
1641
+ */
1642
+ removeAllDimensions(): Dimension[];
1643
+ /**
1644
+ * Removes all the controls from the aggregation {@link #getMeasures measures}.
1645
+ *
1646
+ * Additionally, it unregisters them from the hosting UIArea.
1647
+ *
1648
+ * @returns An array of the removed elements (might be empty)
1649
+ */
1650
+ removeAllMeasures(): Measure[];
1651
+ /**
1652
+ * Unsupported. Chart manages the "data" aggregation only via data binding. The method "removeData" therefore
1653
+ * cannot be used programmatically!
1654
+ */
1655
+ removeData(): void;
1656
+ /**
1657
+ * Removes a dimension from the aggregation dimensions, remove a visible dimension is unsupported when the
1658
+ * property isAnalytical is false.
1659
+ *
1660
+ * @returns The removed dimension or null
1661
+ */
1662
+ removeDimension(
1663
+ /**
1664
+ * The dimension to remove or its index or id.
1665
+ */
1666
+ oDimension: int | string | Dimension
1667
+ ): Dimension;
1668
+ /**
1669
+ * Removes a measure from the aggregation {@link #getMeasures measures}.
1670
+ *
1671
+ * @returns The removed measure or `null`
1672
+ */
1673
+ removeMeasure(
1674
+ /**
1675
+ * The measure to remove or its index or id
1676
+ */
1677
+ vMeasure: int | string | Measure
1678
+ ): Measure | null;
1679
+ /**
1680
+ * Deselect one or more categories from current category selections, specified by category objects.
1681
+ *
1682
+ * Category object has the following structure:
1683
+ * ```javascript
1684
+ *
1685
+ * {
1686
+ * measure: measureName,
1687
+ * dimensions: {
1688
+ * dimensionName1: dimensionValue1,
1689
+ * dimensionName2: dimensionValue2,
1690
+ * ...
1691
+ * }
1692
+ * }
1693
+ * ```
1694
+ *
1695
+ *
1696
+ * Only works when selectionBehavior is "CATEGORY"
1697
+ *
1698
+ * @returns Reference to `this` in order to allow method chaining
1699
+ */
1700
+ removeSelectedCategories(
1701
+ /**
1702
+ * an array of category objects
1703
+ */
1704
+ aCategories: any[]
1705
+ ): this;
1706
+ /**
1707
+ * Deselect one or more data points from current data point selections, specified by datapoint objects.
1708
+ *
1709
+ * Datapoint object has the following structure:
1710
+ * ```javascript
1711
+ *
1712
+ * {
1713
+ * groupId: "groupId", // group ID (optional)
1714
+ * index: index, // index of the data in the group
1715
+ * measures: ["measureId"] // measure IDs
1716
+ * }
1717
+ * ```
1718
+ *
1719
+ *
1720
+ * Only works when selectionBehavior is "DATAPOINT"
1721
+ *
1722
+ * @returns Reference to `this` in order to allow method chaining
1723
+ */
1724
+ removeSelectedDataPoints(
1725
+ /**
1726
+ * an array of datapoint objects.
1727
+ */
1728
+ aDataPoints: any[]
1729
+ ): this;
1730
+ /**
1731
+ * Deselect one or more series from current series selections, specified by series objects.
1732
+ *
1733
+ * Series object has the following structure:
1734
+ * ```javascript
1735
+ *
1736
+ * {
1737
+ * measure: measureName,
1738
+ * dimensions: {
1739
+ * dimensionName1: dimensionValue1,
1740
+ * dimensionName2: dimensionValue2,
1741
+ * ...
1742
+ * }
1743
+ * }
1744
+ * ```
1745
+ *
1746
+ *
1747
+ * Only works when selectionBehavior is "SERIES"
1748
+ *
1749
+ * @returns Reference to `this` in order to allow method chaining
1750
+ */
1751
+ removeSelectedSeries(
1752
+ /**
1753
+ * an array of series objects
1754
+ */
1755
+ aSeries: any[]
1756
+ ): this;
1757
+ /**
1758
+ * Reset to visible layout.
1759
+ *
1760
+ * @returns Reference to `this` in order to allow method chaining
1761
+ */
1762
+ resetLayout(): this;
1763
+ /**
1764
+ * Sets a new value for property {@link #getActiveColoring activeColoring}.
1765
+ *
1766
+ * Active coloring configurations.
1767
+ *
1768
+ * specifies which coloring of the possible colorings is to be applied for the current chart layout. It
1769
+ * holds an object with two properties:
1770
+ *
1771
+ *
1772
+ * - coloring: **mandatory**, specify which kind of coloring should take effect in current chart layout.
1773
+ * Possible values refer to {@link sap.chart.ColoringType} parameters:
1774
+ * `Criticality` supports two parameters: `"dimension"` and `"measure"`. Both are **optional**, one (and
1775
+ * only one) must be provided. This setting disambiguates when multiple colorings for different visible
1776
+ * dimensions and measures are applicable.
1777
+ *
1778
+ * `"measure"` supports two input types:
1779
+ * - `string` for single measure name
1780
+ * - `string[]` of multiple measure names(only supported in **static**), which is relevant in case of
1781
+ * a **static** measure criticality defined on multiple measures. `"dimension"` holds the dimension
1782
+ * name as string value. `Emphasis` supports only one parameter: `"dimension"` which is **optional**.
1783
+ *
1784
+ * `"dimension"` holds the dimension name as string value.
1785
+ *
1786
+ * Example:
1787
+ * ```javascript
1788
+ *
1789
+ * activeColoring: {
1790
+ * coloring: sap.chart.ColoringType.Criticality,
1791
+ * parameters: {
1792
+ * dimension: "AvailabilityStatus”
1793
+ * }
1794
+ * }
1795
+ * ```
1796
+ *
1797
+ *
1798
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1799
+ *
1800
+ * @returns Reference to `this` in order to allow method chaining
1801
+ */
1802
+ setActiveColoring(
1803
+ /**
1804
+ * New value for property `activeColoring`
1805
+ */
1806
+ oActiveColoring?: object
1807
+ ): this;
1808
+ /**
1809
+ * Sets a new value for property {@link #getChartType chartType}.
1810
+ *
1811
+ * Type of the Chart.
1812
+ *
1813
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1814
+ *
1815
+ * Default value is `"bar"`.
1816
+ *
1817
+ * @returns Reference to `this` in order to allow method chaining
1818
+ */
1819
+ setChartType(
1820
+ /**
1821
+ * New value for property `chartType`
1822
+ */
1823
+ sChartType?: string
1824
+ ): this;
1825
+ /**
1826
+ * Sets a new value for property {@link #getColorings colorings}.
1827
+ *
1828
+ * Chart colorings.
1829
+ *
1830
+ * Holds an object with information about the possible options how colors can be applied for indicating
1831
+ * `Criticality` or `Emphasis` in the chart.
1832
+ * ```javascript
1833
+ *
1834
+ * Colorings: {
1835
+ * Criticality: {
1836
+ * …
1837
+ * },
1838
+ * Emphasis: {
1839
+ * …
1840
+ * }
1841
+ * }
1842
+ * ```
1843
+ *
1844
+ *
1845
+ * **NOTE:** Dimension-based coloring does not work when {@link sap.chart.data.Measure#setSemantics} is
1846
+ * set to {@link sap.chart.data.MeasureSemantics.Projected} or {@link sap.chart.data.MeasureSemantics.Reference}
1847
+ * for visible measure(s).
1848
+ *
1849
+ * Refer to
1850
+ * {@link sap.chart.ColoringType.Criticality}
1851
+ * {@link sap.chart.ColoringType.Emphasis}
1852
+ * for detailed usage
1853
+ *
1854
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1855
+ *
1856
+ * @returns Reference to `this` in order to allow method chaining
1857
+ */
1858
+ setColorings(
1859
+ /**
1860
+ * New value for property `colorings`
1861
+ */
1862
+ oColorings?: object
1863
+ ): this;
1864
+ /**
1865
+ * Set the chart custom messages. Supported messages please refer to enum {@link sap.chart.MessageId}.
1866
+ *
1867
+ * The user should handle the message localization.
1868
+ *
1869
+ * Example:
1870
+ *
1871
+ *
1872
+ * ```javascript
1873
+ *
1874
+ * oChart.setCustomMessages({
1875
+ * 'NO_DATA': "No data. Please change your filter"
1876
+ * });
1877
+ * ```
1878
+ *
1879
+ *
1880
+ * When called with an invalid value, the default value will be restored.
1881
+ */
1882
+ setCustomMessages(
1883
+ /**
1884
+ * object containing customMessage values to update
1885
+ */
1886
+ oCustomMessages: object
1887
+ ): this;
1888
+ /**
1889
+ * Sets a new value for property enablePagination, only works for oData model.
1890
+ *
1891
+ * **NOTE:** setEnablePagination currently only works in constructor.
1892
+ *
1893
+ * Enable pagination mode.
1894
+ *
1895
+ * Pagination mode empowers users to visualize dataset page by page by scrolling back or forth. Currently
1896
+ * there are some restrictions of this mode in some chart transversal features, such as:
1897
+ * - Selection status might lost for new batch data
1898
+ * - Keyboard navigation will be only available for current continuous batch data
1899
+ * - Zoom out might have inconsistent behavior, hence the gesture in mobile might have the same issue
1900
+ *
1901
+ * - Time charts did not enable pagination yet
1902
+ * - Series color might be inconsistent before/after jump pages
1903
+ * - parameter `oBindingInfo.length` during {@link sap.ui.base.ManagedObject#bindAggregation bindAggregation}
1904
+ * of {@link #getData data} will not be respected in value axis scale Please refer to release notes
1905
+ * for details.
1906
+ *
1907
+ * When called with a value of null or undefined, the default value of the property will be restored.
1908
+ *
1909
+ * Default value is false.
1910
+ *
1911
+ * @returns Reference to this in order to allow method chaining
1912
+ */
1913
+ setEnablePagination(
1914
+ /**
1915
+ * New value for property enablePagination
1916
+ */
1917
+ bEnablePagination: boolean
1918
+ ): this;
1919
+ /**
1920
+ * Sets a new value for property {@link #getEnableScalingFactor enableScalingFactor}.
1921
+ *
1922
+ * Enable scaling factor.
1923
+ *
1924
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1925
+ *
1926
+ * Default value is `false`.
1927
+ *
1928
+ * @returns Reference to `this` in order to allow method chaining
1929
+ */
1930
+ setEnableScalingFactor(
1931
+ /**
1932
+ * New value for property `enableScalingFactor`
1933
+ */
1934
+ bEnableScalingFactor?: boolean
1935
+ ): this;
1936
+ /**
1937
+ * Sets a new value for property {@link #getEnableStableColor enableStableColor}.
1938
+ *
1939
+ * Enable Stable color mode. To keep the same colors for the same dimension values or measure names.
1940
+ *
1941
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1942
+ *
1943
+ * Default value is `false`.
1944
+ *
1945
+ * @returns Reference to `this` in order to allow method chaining
1946
+ */
1947
+ setEnableStableColor(
1948
+ /**
1949
+ * New value for property `enableStableColor`
1950
+ */
1951
+ bEnableStableColor?: boolean
1952
+ ): this;
1953
+ /**
1954
+ * Sets a new value for property {@link #getHideSharedInformation hideSharedInformation}.
1955
+ *
1956
+ * Hide shared dimensions from selected data points when you drill down. A dimension is hidden if all selected
1957
+ * data points share the same.
1958
+ *
1959
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1960
+ *
1961
+ * Default value is `true`.
1962
+ *
1963
+ * @returns Reference to `this` in order to allow method chaining
1964
+ */
1965
+ setHideSharedInformation(
1966
+ /**
1967
+ * New value for property `hideSharedInformation`
1968
+ */
1969
+ bHideSharedInformation?: boolean
1970
+ ): this;
1971
+ /**
1972
+ * Sets a new value for property {@link #getInResultDimensions inResultDimensions}.
1973
+ *
1974
+ * Names of the inResult dimensions.
1975
+ *
1976
+ * inResult dimension do not show up in chart layout, i.e. axis/legend. They do show in tooltip, popover,
1977
+ * and in selection results.
1978
+ *
1979
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1980
+ *
1981
+ * Default value is `[]`.
1982
+ *
1983
+ * @returns Reference to `this` in order to allow method chaining
1984
+ */
1985
+ setInResultDimensions(
1986
+ /**
1987
+ * New value for property `inResultDimensions`
1988
+ */
1989
+ sInResultDimensions?: string[]
1990
+ ): this;
1991
+ /**
1992
+ * Whether or not an aggregated entity set is bound to the chart. Deprecated.
1993
+ */
1994
+ setIsAnalytical(): this;
1995
+ /**
1996
+ * Select one or more categories, specified by category objects.
1997
+ *
1998
+ * Category object has the following structure:
1999
+ * ```javascript
2000
+ *
2001
+ * {
2002
+ * measure: measureName,
2003
+ * dimensions: {
2004
+ * dimensionName1: dimensionValue1,
2005
+ * dimensionName2: dimensionValue2,
2006
+ * ...
2007
+ * }
2008
+ * }
2009
+ * ```
2010
+ *
2011
+ *
2012
+ * Only works when selectionBehavior is "CATEGORY"
2013
+ *
2014
+ * @returns Reference to `this` in order to allow method chaining
2015
+ */
2016
+ setSelectedCategories(
2017
+ /**
2018
+ * an array of category objects
2019
+ */
2020
+ aCategories: any[]
2021
+ ): this;
2022
+ /**
2023
+ * Select one or more data points, specified by datapoint objects.
2024
+ *
2025
+ * Datapoint object has the following structure:
2026
+ * ```javascript
2027
+ *
2028
+ * {
2029
+ * groupId: "groupId", // group ID (optional)
2030
+ * index: index, // index of the data in the group
2031
+ * measures: ["measureId"] // measure IDs
2032
+ * }
2033
+ * ```
2034
+ *
2035
+ *
2036
+ * Only works when selectionBehavior is "DATAPOINT"
2037
+ *
2038
+ * @returns Reference to `this` in order to allow method chaining
2039
+ */
2040
+ setSelectedDataPoints(
2041
+ /**
2042
+ * an array of datapoint objects.
2043
+ */
2044
+ aDataPoints: any[]
2045
+ ): this;
2046
+ /**
2047
+ * Select one or more series, specified by series objects.
2048
+ *
2049
+ * Series object has the following structure:
2050
+ * ```javascript
2051
+ *
2052
+ * {
2053
+ * measure: measureName,
2054
+ * dimensions: {
2055
+ * dimensionName1: dimensionValue1,
2056
+ * dimensionName2: dimensionValue2,
2057
+ * ...
2058
+ * }
2059
+ * }
2060
+ * ```
2061
+ *
2062
+ *
2063
+ * Only works when selectionBehavior is "SERIES"
2064
+ *
2065
+ * @returns Reference to `this` in order to allow method chaining
2066
+ */
2067
+ setSelectedSeries(
2068
+ /**
2069
+ * an array of series objects
2070
+ */
2071
+ aSeries: any[]
2072
+ ): this;
2073
+ /**
2074
+ * Sets a new value for property {@link #getSelectionBehavior selectionBehavior}.
2075
+ *
2076
+ * Chart selection behavior.
2077
+ *
2078
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2079
+ *
2080
+ * Default value is `DataPoint`.
2081
+ *
2082
+ * @returns Reference to `this` in order to allow method chaining
2083
+ */
2084
+ setSelectionBehavior(
2085
+ /**
2086
+ * New value for property `selectionBehavior`
2087
+ */
2088
+ sSelectionBehavior?: SelectionBehavior
2089
+ ): this;
2090
+ /**
2091
+ * Sets a new value for property {@link #getSelectionMode selectionMode}.
2092
+ *
2093
+ * Chart selection mode.
2094
+ *
2095
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2096
+ *
2097
+ * Default value is `Multi`.
2098
+ *
2099
+ * @returns Reference to `this` in order to allow method chaining
2100
+ */
2101
+ setSelectionMode(
2102
+ /**
2103
+ * New value for property `selectionMode`
2104
+ */
2105
+ sSelectionMode?: SelectionMode
2106
+ ): this;
2107
+ /**
2108
+ * Setter for property uiConfig. uiConfig could only set via settings parameter of constructor.
2109
+ *
2110
+ * uiConfig from base type could config the instance. Supported uiConfig keyword: applicationSet, showErrorMessage
2111
+ *
2112
+ * Example:
2113
+ *
2114
+ *
2115
+ * ```javascript
2116
+ *
2117
+ * var chart = new sap.chart.Chart({
2118
+ * 'chartType' : 'bar',
2119
+ * 'uiConfig' : {
2120
+ * 'applicationSet' : 'fiori',
2121
+ * 'showErrorMessage' : true
2122
+ * }
2123
+ * });
2124
+ * ```
2125
+ */
2126
+ setUiConfig(
2127
+ /**
2128
+ * the UI configuration
2129
+ */
2130
+ oUiConfig: object
2131
+ ): this;
2132
+ /**
2133
+ * Sets a new value for property {@link #getValueAxisScale valueAxisScale}.
2134
+ *
2135
+ * Value Axis Scale.
2136
+ *
2137
+ * Specifies the scale of the chart value axes.
2138
+ *
2139
+ *
2140
+ * - scaleBehavior: **optional**, determines whether or not all value axes in the chart should have a
2141
+ * fixed scale. Possible values refer to {@link sap.chart.ScaleBehavior}. The default value is sap.chart.ScaleBehavior.AutoScale.
2142
+ * In order to apply a fixed scale, boundary values for minimum and maximum must have been specified for
2143
+ * all visible measures, and the axes boundaries are then created from the largest maximum and the smallest
2144
+ * minimum value of the measures put on the respective axis. If any visible measure lacks this information,
2145
+ * or scaleBehavior is set to sap.chart.ScaleBehavior.AutoScale, the chart will apply an automatic scaling
2146
+ * for all value axes.
2147
+ * - fixedScaleSettings:
2148
+ * measureBoundaryValues: An object holding the fixed “minimum” and “maximum” values for all the measures.
2149
+ * Stacked chart with only one measure also uses this object to describe the fixed “minimum” and “maximum”
2150
+ * value.
2151
+ * `measure` Measure name
2152
+ * - stackedMultipleMeasureBoundaryValues: An array of objects holding the fixed “minimum” and “maximum”
2153
+ * values only for stacked chart with multiple measures.
2154
+ * `measures` the array of measure name applied to the axis.
2155
+ * - `boundaryValues:` An object holding the fixed “minimum” and “maximum” value all the measures applied
2156
+ * to certain axis.
2157
+ * - autoScaleSettings:
2158
+ * `zeroAlwaysVisible` forces the value axis to always display the zero value (only a few chart types
2159
+ * support the opposite), which is **optional**. The default value is true.
2160
+ * - `syncWith` selects how the chart adapts the value axis to the data: The axis boundaries may be determined
2161
+ * from the loaded data, which is **optional**. The default value is "DataSet". Possible values refer to
2162
+ * {@link sap.chart.AutoScaleMode}.
2163
+ *
2164
+ * Example:
2165
+ * ```javascript
2166
+ *
2167
+ * valueAxisScale: {
2168
+ * scaleBehavior: sap.chart.ScaleBehavior,
2169
+ * fixedScaleSettings: {
2170
+ * measureBoundaryValues: {
2171
+ * measure_1: {
2172
+ * minimum: Number,
2173
+ * maximum: Number
2174
+ * },
2175
+ * measure_2: {
2176
+ * minimum: Number,
2177
+ * maximum: Number
2178
+ * }
2179
+ * },
2180
+ * stackedMultipleMeasureBoundaryValues: [{
2181
+ * measures: [ 'measure_1', 'measure_2', … ],
2182
+ * boundaryValues: {
2183
+ * minimum: Number,
2184
+ * maximum: Number
2185
+ * }
2186
+ * }, {
2187
+ * measures: [ 'measure_3', 'measure_4', … ],
2188
+ * boundaryValues: {
2189
+ * minimum: Number,
2190
+ * maximum: Number
2191
+ * }
2192
+ * }]
2193
+ * },
2194
+ * autoScaleSettings: {
2195
+ * zeroAlwaysVisible: Boolean,
2196
+ * syncWith: sap.chart.autoScaleMode
2197
+ * }
2198
+ * }
2199
+ * ```
2200
+ *
2201
+ *
2202
+ * Refer to
2203
+ * {@link sap.chart.AutoScaleMode.DataSet}
2204
+ * {@link sap.chart.AutoScaleMode.VisibleData}
2205
+ * {@link sap.chart.ScaleBehavior.AutoScale}
2206
+ * {@link sap.chart.ScaleBehavior.FixedScale}
2207
+ * for detailed usage
2208
+ *
2209
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2210
+ *
2211
+ * @returns Reference to `this` in order to allow method chaining
2212
+ */
2213
+ setValueAxisScale(
2214
+ /**
2215
+ * New value for property `valueAxisScale`
2216
+ */
2217
+ oValueAxisScale?: object
2218
+ ): this;
2219
+ /**
2220
+ * Sets a new value for property visibleDimensions.
2221
+ *
2222
+ * Names of the Dimensions to be displayed in the Chart, all available dimensions will automatically append
2223
+ * when the property isAnalytical is false.
2224
+ *
2225
+ * Depending on chart type, insufficient number of visible Dimensions will cause error.
2226
+ *
2227
+ * When called with a value of null or undefined, the default value of the property will be restored.
2228
+ *
2229
+ * Default value is [].
2230
+ *
2231
+ * @returns Reference to this in order to allow method chaining
2232
+ */
2233
+ setVisibleDimensions(
2234
+ /**
2235
+ * New value for property visibleDimensions
2236
+ */
2237
+ sVisibleDimensions: string[]
2238
+ ): this;
2239
+ /**
2240
+ * Sets a new value for property {@link #getVisibleMeasures visibleMeasures}.
2241
+ *
2242
+ * Names of the Measures to be displayed in the Chart.
2243
+ *
2244
+ * Depending on chart type, insufficient number of visible `Measure`s will cause errors.
2245
+ *
2246
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2247
+ *
2248
+ * Default value is `[]`.
2249
+ *
2250
+ * @returns Reference to `this` in order to allow method chaining
2251
+ */
2252
+ setVisibleMeasures(
2253
+ /**
2254
+ * New value for property `visibleMeasures`
2255
+ */
2256
+ sVisibleMeasures?: string[]
2257
+ ): this;
2258
+ /**
2259
+ * Change Chart's properties.
2260
+ *
2261
+ * Chart's properties will be updated with the parameter.
2262
+ *
2263
+ * Refer to chart property documentation for more
2264
+ * details.
2265
+ */
2266
+ setVizProperties(
2267
+ /**
2268
+ * object containing vizProperty values to update
2269
+ */
2270
+ oVizProperties: object
2271
+ ): this;
2272
+ /**
2273
+ * Change Chart's scales.
2274
+ *
2275
+ * Chart's scales will be updated with the parameters.
2276
+ *
2277
+ * Refer to chart property documentation for more
2278
+ * details.
2279
+ */
2280
+ setVizScales(
2281
+ /**
2282
+ * array of vizScale objects
2283
+ */
2284
+ oVizScales: object[]
2285
+ ): this;
2286
+ /**
2287
+ * Unbinds aggregation {@link #getData data} from model data.
2288
+ *
2289
+ * @returns Reference to `this` in order to allow method chaining
2290
+ */
2291
+ unbindData(): this;
2292
+ /**
2293
+ * Zoom the chart plot.
2294
+ *
2295
+ * Example:
2296
+ * ```javascript
2297
+ *
2298
+ * var oChart = new sap.chart.Chart(...);
2299
+ * oChart.zoom({direction: "in"});
2300
+ * ```
2301
+ */
2302
+ zoom(
2303
+ /**
2304
+ * contains a "direction" attribute with value "in" or "out" indicating zoom to enlarge or shrink respectively
2305
+ */
2306
+ oConfig: object
2307
+ ): void;
2308
+ }
2309
+
2310
+ export interface $ChartSettings extends $BaseControlSettings {
2311
+ /**
2312
+ * Type of the Chart.
2313
+ */
2314
+ chartType?: string | PropertyBindingInfo;
2315
+
2316
+ /**
2317
+ * Configuration for initialization to VizControl. This property could only set via settings parameter in
2318
+ * Constructor.
2319
+ */
2320
+ uiConfig?: object | PropertyBindingInfo | `{${string}}`;
2321
+
2322
+ /**
2323
+ * Names of the Dimensions to be displayed in the Chart, all available dimensions will automatically append
2324
+ * when the property isAnalytical is false.
2325
+ *
2326
+ * Depending on chart type, insufficient number of visible `Dimension`s will cause error.
2327
+ */
2328
+ visibleDimensions?: string[] | PropertyBindingInfo | `{${string}}`;
2329
+
2330
+ /**
2331
+ * Names of the inResult dimensions.
2332
+ *
2333
+ * inResult dimension do not show up in chart layout, i.e. axis/legend. They do show in tooltip, popover,
2334
+ * and in selection results.
2335
+ */
2336
+ inResultDimensions?: string[] | PropertyBindingInfo | `{${string}}`;
2337
+
2338
+ /**
2339
+ * Names of the Measures to be displayed in the Chart.
2340
+ *
2341
+ * Depending on chart type, insufficient number of visible `Measure`s will cause errors.
2342
+ */
2343
+ visibleMeasures?: string[] | PropertyBindingInfo | `{${string}}`;
2344
+
2345
+ /**
2346
+ * Chart properties, refer to chart property documentation
2347
+ * for more details.
2348
+ */
2349
+ vizProperties?: object | PropertyBindingInfo | `{${string}}`;
2350
+
2351
+ /**
2352
+ * Chart scales, refer to chart property documentation
2353
+ * for more details.
2354
+ */
2355
+ vizScales?: object[] | PropertyBindingInfo | `{${string}}`;
2356
+
2357
+ /**
2358
+ * Whether or not an aggregated entity set is bound to the chart.
2359
+ */
2360
+ isAnalytical?: boolean | PropertyBindingInfo | `{${string}}`;
2361
+
2362
+ /**
2363
+ * Chart selection behavior.
2364
+ */
2365
+ selectionBehavior?: SelectionBehavior | PropertyBindingInfo | `{${string}}`;
2366
+
2367
+ /**
2368
+ * Chart selection mode.
2369
+ */
2370
+ selectionMode?: SelectionMode | PropertyBindingInfo | `{${string}}`;
2371
+
2372
+ /**
2373
+ * Enable pagination mode.
2374
+ *
2375
+ * Pagination mode empowers users to visualize dataset page by page by scrolling back or forth. Currently
2376
+ * there are some restrictions of this mode in some chart transversal features, such as:
2377
+ * - Selection status might lost for new batch data
2378
+ * - Keyboard navigation will be only available for current continuous batch data
2379
+ * - Zoom out might have inconsistent behavior, Hence the gesture in mobile might have the same issue
2380
+ *
2381
+ * - Time charts did not enable pagination yet
2382
+ * - Series color might be inconsistent before/after jump pages
2383
+ * - OData V4 Model with relative binding is not supported in pagination Please refer to release
2384
+ * notes for details.
2385
+ */
2386
+ enablePagination?: boolean | PropertyBindingInfo | `{${string}}`;
2387
+
2388
+ /**
2389
+ * Enable Stable color mode. To keep the same colors for the same dimension values or measure names.
2390
+ */
2391
+ enableStableColor?: boolean | PropertyBindingInfo | `{${string}}`;
2392
+
2393
+ /**
2394
+ * Enable scaling factor.
2395
+ */
2396
+ enableScalingFactor?: boolean | PropertyBindingInfo | `{${string}}`;
2397
+
2398
+ /**
2399
+ * Chart custom messages.
2400
+ */
2401
+ customMessages?: object | PropertyBindingInfo | `{${string}}`;
2402
+
2403
+ /**
2404
+ * Chart colorings.
2405
+ *
2406
+ * Holds an object with information about the possible options how colors can be applied for indicating
2407
+ * `Criticality` or `Emphasis` in the chart.
2408
+ * ```javascript
2409
+ *
2410
+ * Colorings: {
2411
+ * Criticality: {
2412
+ * …
2413
+ * },
2414
+ * Emphasis: {
2415
+ * …
2416
+ * }
2417
+ * }
2418
+ * ```
2419
+ *
2420
+ *
2421
+ * **NOTE:** Dimension-based coloring does not work when {@link sap.chart.data.Measure#setSemantics} is
2422
+ * set to {@link sap.chart.data.MeasureSemantics.Projected} or {@link sap.chart.data.MeasureSemantics.Reference}
2423
+ * for visible measure(s).
2424
+ *
2425
+ * Refer to
2426
+ * {@link sap.chart.ColoringType.Criticality}
2427
+ * {@link sap.chart.ColoringType.Emphasis}
2428
+ * for detailed usage
2429
+ */
2430
+ colorings?: object | PropertyBindingInfo | `{${string}}`;
2431
+
2432
+ /**
2433
+ * Active coloring configurations.
2434
+ *
2435
+ * specifies which coloring of the possible colorings is to be applied for the current chart layout. It
2436
+ * holds an object with two properties:
2437
+ *
2438
+ *
2439
+ * - coloring: **mandatory**, specify which kind of coloring should take effect in current chart layout.
2440
+ * Possible values refer to {@link sap.chart.ColoringType} parameters:
2441
+ * `Criticality` supports two parameters: `"dimension"` and `"measure"`. Both are **optional**, one (and
2442
+ * only one) must be provided. This setting disambiguates when multiple colorings for different visible
2443
+ * dimensions and measures are applicable.
2444
+ *
2445
+ * `"measure"` supports two input types:
2446
+ * - `string` for single measure name
2447
+ * - `string[]` of multiple measure names(only supported in **static**), which is relevant in case of
2448
+ * a **static** measure criticality defined on multiple measures. `"dimension"` holds the dimension
2449
+ * name as string value. `Emphasis` supports only one parameter: `"dimension"` which is **optional**.
2450
+ *
2451
+ * `"dimension"` holds the dimension name as string value.
2452
+ *
2453
+ * Example:
2454
+ * ```javascript
2455
+ *
2456
+ * activeColoring: {
2457
+ * coloring: sap.chart.ColoringType.Criticality,
2458
+ * parameters: {
2459
+ * dimension: "AvailabilityStatus”
2460
+ * }
2461
+ * }
2462
+ * ```
2463
+ */
2464
+ activeColoring?: object | PropertyBindingInfo | `{${string}}`;
2465
+
2466
+ /**
2467
+ * Value Axis Scale.
2468
+ *
2469
+ * Specifies the scale of the chart value axes.
2470
+ *
2471
+ *
2472
+ * - scaleBehavior: **optional**, determines whether or not all value axes in the chart should have a
2473
+ * fixed scale. Possible values refer to {@link sap.chart.ScaleBehavior}. The default value is sap.chart.ScaleBehavior.AutoScale.
2474
+ * In order to apply a fixed scale, boundary values for minimum and maximum must have been specified for
2475
+ * all visible measures, and the axes boundaries are then created from the largest maximum and the smallest
2476
+ * minimum value of the measures put on the respective axis. If any visible measure lacks this information,
2477
+ * or scaleBehavior is set to sap.chart.ScaleBehavior.AutoScale, the chart will apply an automatic scaling
2478
+ * for all value axes.
2479
+ * - fixedScaleSettings:
2480
+ * measureBoundaryValues: An object holding the fixed “minimum” and “maximum” values for all the measures.
2481
+ * Stacked chart with only one measure also uses this object to describe the fixed “minimum” and “maximum”
2482
+ * value.
2483
+ * `measure` Measure name
2484
+ * - stackedMultipleMeasureBoundaryValues: An array of objects holding the fixed “minimum” and “maximum”
2485
+ * values only for stacked chart with multiple measures.
2486
+ * `measures` the array of measure name applied to the axis.
2487
+ * - `boundaryValues:` An object holding the fixed “minimum” and “maximum” value all the measures applied
2488
+ * to certain axis.
2489
+ * - autoScaleSettings:
2490
+ * `zeroAlwaysVisible` forces the value axis to always display the zero value (only a few chart types
2491
+ * support the opposite), which is **optional**. The default value is true.
2492
+ * - `syncWith` selects how the chart adapts the value axis to the data: The axis boundaries may be determined
2493
+ * from the loaded data, which is **optional**. The default value is "DataSet". Possible values refer to
2494
+ * {@link sap.chart.AutoScaleMode}.
2495
+ *
2496
+ * Example:
2497
+ * ```javascript
2498
+ *
2499
+ * valueAxisScale: {
2500
+ * scaleBehavior: sap.chart.ScaleBehavior,
2501
+ * fixedScaleSettings: {
2502
+ * measureBoundaryValues: {
2503
+ * measure_1: {
2504
+ * minimum: Number,
2505
+ * maximum: Number
2506
+ * },
2507
+ * measure_2: {
2508
+ * minimum: Number,
2509
+ * maximum: Number
2510
+ * }
2511
+ * },
2512
+ * stackedMultipleMeasureBoundaryValues: [{
2513
+ * measures: [ 'measure_1', 'measure_2', … ],
2514
+ * boundaryValues: {
2515
+ * minimum: Number,
2516
+ * maximum: Number
2517
+ * }
2518
+ * }, {
2519
+ * measures: [ 'measure_3', 'measure_4', … ],
2520
+ * boundaryValues: {
2521
+ * minimum: Number,
2522
+ * maximum: Number
2523
+ * }
2524
+ * }]
2525
+ * },
2526
+ * autoScaleSettings: {
2527
+ * zeroAlwaysVisible: Boolean,
2528
+ * syncWith: sap.chart.autoScaleMode
2529
+ * }
2530
+ * }
2531
+ * ```
2532
+ *
2533
+ *
2534
+ * Refer to
2535
+ * {@link sap.chart.AutoScaleMode.DataSet}
2536
+ * {@link sap.chart.AutoScaleMode.VisibleData}
2537
+ * {@link sap.chart.ScaleBehavior.AutoScale}
2538
+ * {@link sap.chart.ScaleBehavior.FixedScale}
2539
+ * for detailed usage
2540
+ */
2541
+ valueAxisScale?: object | PropertyBindingInfo | `{${string}}`;
2542
+
2543
+ /**
2544
+ * Hide shared dimensions from selected data points when you drill down. A dimension is hidden if all selected
2545
+ * data points share the same.
2546
+ */
2547
+ hideSharedInformation?: boolean | PropertyBindingInfo | `{${string}}`;
2548
+
2549
+ /**
2550
+ * Actual data. It can be bound to an (analytical) ODataModel.
2551
+ *
2552
+ * **NOTE:** The metadataLoaded event {@link sap.ui.model.odata.v2.ODataModel#attachMetadataLoaded} need
2553
+ * to be listened when bind to v2 ODataModel.
2554
+ */
2555
+ data?: UI5Element[] | UI5Element | AggregationBindingInfo | `{${string}}`;
2556
+
2557
+ /**
2558
+ * Dimensions of the data.
2559
+ */
2560
+ dimensions?:
2561
+ | Dimension[]
2562
+ | Dimension
2563
+ | AggregationBindingInfo
2564
+ | `{${string}}`;
2565
+
2566
+ /**
2567
+ * Measures of the data.
2568
+ */
2569
+ measures?: Measure[] | Measure | AggregationBindingInfo | `{${string}}`;
2570
+
2571
+ /**
2572
+ * fired after a drill-down operation
2573
+ */
2574
+ drilledDown?: (oEvent: Event) => void;
2575
+
2576
+ /**
2577
+ * fired after a drill-up operation
2578
+ */
2579
+ drilledUp?: (oEvent: Event) => void;
2580
+
2581
+ /**
2582
+ * Event fires when the rendering ends.
2583
+ */
2584
+ renderComplete?: (oEvent: Event) => void;
2585
+
2586
+ /**
2587
+ * Event fires when certain data point(s) is(are) selected, data context of selected item(s) would be passed
2588
+ * in.
2589
+ */
2590
+ selectData?: (oEvent: Event) => void;
2591
+
2592
+ /**
2593
+ * Event fires when certain data point(s) is(are) deselected, data context of deselected item(s) would be
2594
+ * passed in
2595
+ */
2596
+ deselectData?: (oEvent: Event) => void;
2597
+
2598
+ /**
2599
+ * Event fires when fixed scale is turned off by adding or removing dimension
2600
+ */
2601
+ valueAxisFixedScaleTurnedOff?: (oEvent: Event) => void;
2602
+
2603
+ /**
2604
+ * Event fires when drill stack changed. API that relies on drill stack like {@link #drillDown}, {@link
2605
+ * #drillUp} shall be called in this event or after chart is rendered
2606
+ */
2607
+ drillStackChanged?: (oEvent: Event) => void;
2608
+ }
2609
+ }
2610
+
2611
+ declare module "sap/chart/ChartType" {
2612
+ /**
2613
+ * Enumeration for supported chart types in analytical chart
2614
+ */
2615
+ interface ChartType {
2616
+ /**
2617
+ * Bar Chart
2618
+ */
2619
+ Bar: undefined;
2620
+
2621
+ /**
2622
+ * Bubble Chart
2623
+ */
2624
+ Bubble: undefined;
2625
+
2626
+ /**
2627
+ * Bubble Chart
2628
+ */
2629
+ Bullet: undefined;
2630
+
2631
+ /**
2632
+ * Column Chart
2633
+ */
2634
+ Column: undefined;
2635
+
2636
+ /**
2637
+ * Combined Column Line Chart
2638
+ */
2639
+ Combination: undefined;
2640
+
2641
+ /**
2642
+ * Donut Chart
2643
+ */
2644
+ Donut: undefined;
2645
+
2646
+ /**
2647
+ * Bar Chart with 2 X-Axes
2648
+ */
2649
+ DualBar: undefined;
2650
+
2651
+ /**
2652
+ * Column Chart with 2 Y-Axes
2653
+ */
2654
+ DualColumn: undefined;
2655
+
2656
+ /**
2657
+ * Combined Column Line Chart with 2 Y-Axes
2658
+ */
2659
+ DualCombination: undefined;
2660
+
2661
+ /**
2662
+ * Horizontal Combined Bar Line Chart with 2 X-Axes
2663
+ */
2664
+ DualHorizontalCombination: undefined;
2665
+
2666
+ /**
2667
+ * Horizontal Combined Stacked Line Chart with 2 X-Axes
2668
+ */
2669
+ DualHorizontalStackedCombination: undefined;
2670
+
2671
+ /**
2672
+ * Line Chart with 2 Y-Axes
2673
+ */
2674
+ DualLine: undefined;
2675
+
2676
+ /**
2677
+ * Stacked Bar Chart with 2 X-Axes
2678
+ */
2679
+ DualStackedBar: undefined;
2680
+
2681
+ /**
2682
+ * Stacked Column Chart with 2 Y-Axes
2683
+ */
2684
+ DualStackedColumn: undefined;
2685
+
2686
+ /**
2687
+ * Combined Stacked Line Chart with 2 Y-Axes
2688
+ */
2689
+ DualStackedCombination: undefined;
2690
+
2691
+ /**
2692
+ * Heat Map
2693
+ */
2694
+ Heatmap: undefined;
2695
+
2696
+ /**
2697
+ * Horizontal Combined Stacked Line Chart
2698
+ */
2699
+ HorizontalStackedCombination: undefined;
2700
+
2701
+ /**
2702
+ * Horizontal Waterfall Chart
2703
+ */
2704
+ HorizontalWaterfall: undefined;
2705
+
2706
+ /**
2707
+ * Line Chart
2708
+ */
2709
+ Line: undefined;
2710
+
2711
+ /**
2712
+ * 100% Donut Chart
2713
+ */
2714
+ PercentageDonut: undefined;
2715
+
2716
+ /**
2717
+ * 100% Stacked Bar Chart with 2 X-Axes
2718
+ */
2719
+ PercentageDualStackedBar: undefined;
2720
+
2721
+ /**
2722
+ * 100% Stacked Column Chart with 2 Y-Axes
2723
+ */
2724
+ PercentageDualStackedColumn: undefined;
2725
+
2726
+ /**
2727
+ * 100% Stacked Bar Chart
2728
+ */
2729
+ PercentageStackedBar: undefined;
2730
+
2731
+ /**
2732
+ * 100% Stacked Column Chart
2733
+ */
2734
+ PercentageStackedColumn: undefined;
2735
+
2736
+ /**
2737
+ * Pie Chart
2738
+ */
2739
+ Pie: undefined;
2740
+
2741
+ /**
2742
+ * Scatter Plot
2743
+ */
2744
+ Scatter: undefined;
2745
+
2746
+ /**
2747
+ * Stacked Bar Chart
2748
+ */
2749
+ StackedBar: undefined;
2750
+
2751
+ /**
2752
+ * Stacked Column Chart
2753
+ */
2754
+ StackedColumn: undefined;
2755
+
2756
+ /**
2757
+ * Combined Stacked Line Chart
2758
+ */
2759
+ StackedCombination: undefined;
2760
+
2761
+ /**
2762
+ * Vertical Bullet Chart
2763
+ */
2764
+ VerticalBullet: undefined;
2765
+
2766
+ /**
2767
+ * Waterfall Chart
2768
+ */
2769
+ Waterfall: undefined;
2770
+ }
2771
+ const ChartType: ChartType;
2772
+ export default ChartType;
2773
+ }
2774
+
2775
+ declare module "sap/chart/coloring/CriticalityType" {
2776
+ /**
2777
+ * Enumeration for supported criticality types in analytical chart
2778
+ */
2779
+ enum CriticalityType {
2780
+ /**
2781
+ * Critical
2782
+ */
2783
+ Critical = "Critical",
2784
+ /**
2785
+ * Negative
2786
+ */
2787
+ Negative = "Negative",
2788
+ /**
2789
+ * Neutral
2790
+ */
2791
+ Neutral = "Neutral",
2792
+ /**
2793
+ * Positive
2794
+ */
2795
+ Positive = "Positive",
2796
+ }
2797
+ export default CriticalityType;
2798
+ }
2799
+
2800
+ declare module "sap/chart/ColoringType" {
2801
+ /**
2802
+ * Enum of available colorings.
2803
+ */
2804
+ enum ColoringType {
2805
+ /**
2806
+ * Criticality is based on the semantic color palette.
2807
+ *
2808
+ * It can be defined for measure values and dimension values.
2809
+ * ```javascript
2810
+ *
2811
+ * Criticality: {
2812
+ * MeasureValues: {
2813
+ * ...
2814
+ * },
2815
+ * DimensionValues: {
2816
+ * ...
2817
+ * }
2818
+ * }
2819
+ * ```
2820
+ *
2821
+ *
2822
+ * **For measure values**, criticality can be based on `static`, `calculated`, `DynamicThresholds` and `ConstantThresholds`
2823
+ *
2824
+ * `Legend` is **optional** and can be used for custom legend labels.
2825
+ * ```javascript
2826
+ *
2827
+ * MeasureValues: {
2828
+ * 'measureName': {
2829
+ * Static: ... ,
2830
+ * Calculated: ... ,
2831
+ * DynamicThresholds: {
2832
+ * ...
2833
+ * },
2834
+ * ConstantThresholds: {
2835
+ * ...
2836
+ * },
2837
+ * Legend: {
2838
+ * Title: string, // (optional) fixed, localized label
2839
+ * Positive: string, // fixed, localized label
2840
+ * Critical: string, // fixed, localized label
2841
+ * Negative: string, // fixed, localized label
2842
+ * Neutral: string // fixed, localized label
2843
+ * }
2844
+ * },
2845
+ * 'measureName': {
2846
+ * ...
2847
+ * }
2848
+ * }
2849
+ * ```
2850
+ *
2851
+ * `static`
2852
+ *
2853
+ * It indicates that the measure is always considered in the same way, for example positive.
2854
+ *
2855
+ * The value of `static` is listed in {@link sap.chart.coloring.CriticalityType}
2856
+ *
2857
+ * Example:
2858
+ *
2859
+ * In this case, all 'Profit' datapoints shall use Positive semantic color and all 'Revenue' datapoints
2860
+ * shall use Negative semantic color.
2861
+ * ```javascript
2862
+ *
2863
+ * var oColorings = {
2864
+ * Criticality: {
2865
+ * MeasureValues: {
2866
+ * Profit: {
2867
+ * Static: sap.chart.ColoringType.Positive
2868
+ * },
2869
+ * Revenue: {
2870
+ * Static: sap.chart.ColoringType.Negative
2871
+ * }
2872
+ * }
2873
+ * }
2874
+ * };
2875
+ * var oActiveColoring = {
2876
+ * coloring: sap.chart.ColoringType.Criticality,
2877
+ * parameters: {
2878
+ * measure: ['Profit', 'Revenue']
2879
+ * }
2880
+ * };
2881
+ * ```
2882
+ * `Calculated`
2883
+ *
2884
+ * Criticality is calculated by the backend service.
2885
+ *
2886
+ * For a `Calculated` criticality, the value will be determined from a property contained in the model of
2887
+ * the “data” aggregation. Since the calculation must always take the currently visible dimensions into
2888
+ * account, this property will be a measure holding an aggregated criticality for the current aggregation
2889
+ * level. The concrete possible values held by this property are defined in {@link sap.chart.coloring.CriticalityType}:
2890
+ * Neutral = 0, Negative = 1, Critical = 2, Positive =3.
2891
+ *
2892
+ * If Legend is present, the legend shows the title and the fixed, localized texts defined for the different
2893
+ * criticality classes. Otherwise, the chart uses the default texts “Good”, “Warning”, “Bad”, and “Neutral”
2894
+ * as localized labels in the legend.
2895
+ *
2896
+ * If the value of `Calculated` is a dimension name. The criticality of the measure of a datapoint is determined
2897
+ * by the value of this dimension and its textProperty(if exists) will be used as legend label.
2898
+ *
2899
+ * The possible values of this certain dimension are listed in {@link sap.chart.coloring.CriticalityType}.
2900
+ *
2901
+ * Example:
2902
+ *
2903
+ * In this case, the criticality of 'Profit' measure is determined by the value of 'ProfitCriticality' dimension
2904
+ * which is calculated by backend service.
2905
+ * ```javascript
2906
+ *
2907
+ * var oColorings = {
2908
+ * Criticality: {
2909
+ * MeasureValues: {
2910
+ * Profit: {
2911
+ * Calculated: 'ProfitCriticality'
2912
+ * }
2913
+ * }
2914
+ * }
2915
+ * };
2916
+ * var oActiveColoring = {
2917
+ * coloring: sap.chart.ColoringType.Criticality,
2918
+ * parameters: {
2919
+ * measure: ['Profit']
2920
+ * }
2921
+ * };
2922
+ * ```
2923
+ *
2924
+ *
2925
+ * In this case, the criticality of 'Profit' measure is determined by the value of 'ProfitCriticalityM'
2926
+ * measure which is calculated by backend service.
2927
+ * ```javascript
2928
+ *
2929
+ * var oColorings = {
2930
+ * Criticality: {
2931
+ * MeasureValues: {
2932
+ * Profit: {
2933
+ * Calculated: 'ProfitCriticalityM',
2934
+ * Legend: {
2935
+ * Title: "Legend Title",
2936
+ * Positive: "Good",
2937
+ * Negative: "Weak",
2938
+ * Critical: "Soso",
2939
+ * Neutral: "Crossbench"
2940
+ * }
2941
+ * }
2942
+ * }
2943
+ * }
2944
+ * };
2945
+ * var oActiveColoring = {
2946
+ * coloring: sap.chart.ColoringType.Criticality,
2947
+ * parameters: {
2948
+ * measure: ['Profit']
2949
+ * }
2950
+ * };
2951
+ * ```
2952
+ * `DynamicThresholds`
2953
+ *
2954
+ * Criticality is expressed with thresholds for the boundaries between negative, critical, neutral, and
2955
+ * positive.
2956
+ *
2957
+ * The direction of improvement for measure values is mandatory, combined with corresponding thresholds.
2958
+ *
2959
+ * Thresholds are optional. For unassigned values, defaults are determined in this order:
2960
+ *
2961
+ * - For DeviationRange, an omitted LowValue translates into the smallest possible number (-INF), an omitted
2962
+ * HighValue translates into the largest possible number (+INF)
2963
+ *
2964
+ * - For ToleranceRange, an omitted LowValue will be initialized with DeviationRangeLowValue, an omitted
2965
+ * HighValue will be initialized with DeviationRangeHighValue
2966
+ *
2967
+ * - For AcceptanceRange, an omitted LowValue will be initialized with ToleranceRangeLowValue, an omitted
2968
+ * HighValue will be initialized with ToleranceRangeHighValue
2969
+ *
2970
+ * Please refer to {@link sap.chart.coloring.ImprovementDirectionType} for detailed usage.
2971
+ * ```javascript
2972
+ *
2973
+ * DynamicThresholds: {
2974
+ * ImprovementDirection: string, // refer to sap.chart.coloring.ImprovementDirectionType for detailed definition
2975
+ * AcceptanceRangeLowValue: string or number, // property name or number
2976
+ * AcceptanceRangeHighValue: string or number, // property name or number
2977
+ * ToleranceRangeLowValue: string or number, // property name or number
2978
+ * ToleranceRangeHighValue: string or number, // property name or number
2979
+ * DeviationRangeLowValue: string or number, // property name or number
2980
+ * DeviationRangeHighValue: string or number, // property name or number
2981
+ * }
2982
+ * ```
2983
+ * Example:
2984
+ *
2985
+ * In this case, the criticality of 'Profit' measure is determined by the value of 'ProfitAcceptanceRangeLowValue',
2986
+ * 'ProfitToleranceRangeLowValue' and 'ProfitDeviationRangeLowValue' measure calculated with improvement
2987
+ * direction `'Maximize'`.
2988
+ * ```javascript
2989
+ *
2990
+ * var oColorings = {
2991
+ * Criticality: {
2992
+ * MeasureValues: {
2993
+ * Profit: {
2994
+ * DynamicThresholds : {
2995
+ * ImprovementDirection: sap.chart.coloring.ImprovementDirectionType.Maximize,
2996
+ * AcceptanceRangeLowValue: 'ProfitAcceptanceRangeLowValue',
2997
+ * ToleranceRangeLowValue: 'ProfitToleranceRangeLowValue',
2998
+ * DeviationRangeLowValue: 'ProfitDeviationRangeLowValue'
2999
+ * }
3000
+ * }
3001
+ * }
3002
+ * }
3003
+ * };
3004
+ * var oActiveColoring = {
3005
+ * coloring: sap.chart.ColoringType.Criticality,
3006
+ * parameters: {
3007
+ * measure: ['Profit']
3008
+ * }
3009
+ * };
3010
+ * ```
3011
+ * `ConstantThresholds`
3012
+ *
3013
+ * Criticality is expressed with thresholds for the boundaries between negative, critical, neutral, and
3014
+ * positive.
3015
+ *
3016
+ * The direction of improvement for measure values is mandatory, combined with corresponding thresholds.
3017
+ *
3018
+ * Thresholds are optional. For unassigned values, defaults are determined in this order:
3019
+ *
3020
+ * - For DeviationRange, an omitted LowValue translates into the smallest possible number (-INF), an omitted
3021
+ * HighValue translates into the largest possible number (+INF)
3022
+ *
3023
+ * - For ToleranceRange, an omitted LowValue will be initialized with DeviationRangeLowValue, an omitted
3024
+ * HighValue will be initialized with DeviationRangeHighValue
3025
+ *
3026
+ * - For AcceptanceRange, an omitted LowValue will be initialized with ToleranceRangeLowValue, an omitted
3027
+ * HighValue will be initialized with ToleranceRangeHighValue
3028
+ *
3029
+ * Also Aggregation level (the visible dimensions) must be specified for providing the context for assessing
3030
+ * the criticality.
3031
+ *
3032
+ * Legend label is shown as value range and do not support customization in ConstantThresholds.
3033
+ *
3034
+ * Please refer to {@link sap.chart.coloring.ImprovementDirectionType} for detailed usage.
3035
+ * ```javascript
3036
+ *
3037
+ * ConstantThresholds: {
3038
+ * ImprovementDirection: string, refer to sap.chart.coloring.ImprovementDirectionType for detailed definition
3039
+ * AggregationLevels: [{
3040
+ * VisibleDimensions: ['dimensionName', ...],
3041
+ * AcceptanceRangeLowValue: Number,
3042
+ * AcceptanceRangeHighValue:Number,
3043
+ * ToleranceRangeLowValue: Number,
3044
+ * ToleranceRangeHighValue: Number,
3045
+ * DeviationRangeLowValue: Number,
3046
+ * DeviationRangeHighValue: Number
3047
+ * },
3048
+ * ...]
3049
+ * }
3050
+ * ```
3051
+ * Example:
3052
+ *
3053
+ * In this case, the criticality of 'Profit' measure is determined by two concrete thresholds calculated
3054
+ * with improvement direction `'Maximize'`.
3055
+ * ```javascript
3056
+ *
3057
+ * var oColorings = {
3058
+ * Criticality: {
3059
+ * MeasureValues: {
3060
+ * Profit: {
3061
+ * ConstantThresholds : {
3062
+ * ImprovementDirection: sap.chart.coloring.ImprovementDirectionType.Maximize,
3063
+ * AcceptanceRangeLowValue:100,
3064
+ * ToleranceRangeLowValue: 80,
3065
+ * DeviationRangeLowValue: 60
3066
+ * }
3067
+ * }
3068
+ * }
3069
+ * }
3070
+ * };
3071
+ * var oActiveColoring = {
3072
+ * coloring: sap.chart.ColoringType.Criticality,
3073
+ * parameters: {
3074
+ * measure: ['Profit']
3075
+ * }
3076
+ * };
3077
+ * ```
3078
+ *
3079
+ *
3080
+ * **For dimension values**
3081
+ *
3082
+ * Criticality can be expressed by assigning values to negative, critical, and positive. Unassigned dimension
3083
+ * values are automatically assigned to neutral.
3084
+ *
3085
+ * `'Values'` is used to specify concrete dimension value(s). `'Legend'` is used to customize legend label
3086
+ * which is mandatory when multiple dimension values defined in `'Values'`.
3087
+ *
3088
+ *
3089
+ * ```javascript
3090
+ *
3091
+ * DimensionValues: {
3092
+ * 'dimensionName': {
3093
+ * Positive: {
3094
+ * Values: 'dimensionValue' or ['dimensionValue', ...]
3095
+ * Legend: string // mandatory for value array
3096
+ * },
3097
+ * Critical: {
3098
+ * Values: 'dimensionValue' or ['dimensionValue', ...]
3099
+ * Legend: string // mandatory for value array
3100
+ * },
3101
+ * Negative: {
3102
+ * Values: 'dimensionValue' or ['dimensionValue', ...]
3103
+ * Legend: string // mandatory for value array
3104
+ * },
3105
+ * Neutral: {
3106
+ * Values: 'dimensionValue' or ['dimensionValue', ...]
3107
+ * Legend: string // mandatory for value array
3108
+ * }
3109
+ * },
3110
+ * 'dimensionName': {
3111
+ * ...
3112
+ * }
3113
+ * }
3114
+ * ```
3115
+ * Example:
3116
+ *
3117
+ * In this case, the criticality of 'OrderStatus' dimension is determined by values specified to different
3118
+ * criticality classes.
3119
+ * ```javascript
3120
+ *
3121
+ * var oColorings = {
3122
+ * Criticality: {
3123
+ * DimensionValues: {
3124
+ * OrderStatus: {
3125
+ * Positive : {
3126
+ * Values: 'Finished'
3127
+ * },
3128
+ * Critical : {
3129
+ * Values: 'Pending'
3130
+ * },
3131
+ * Negative : {
3132
+ * Values: ['Stopped', 'Not Started'],
3133
+ * Legend: 'Alert'
3134
+ * },
3135
+ * Neutral : {
3136
+ * Values: ['Processing', 'Surveyed'],
3137
+ * Legend: 'Normal'
3138
+ * }
3139
+ * }
3140
+ * }
3141
+ * }
3142
+ * };
3143
+ * var oActiveColoring = {
3144
+ * coloring: sap.chart.ColoringType.Criticality,
3145
+ * parameters: {
3146
+ * dimension: ['OrderStatus']
3147
+ * }
3148
+ * };
3149
+ * ```
3150
+ */
3151
+ Criticality = "Criticality",
3152
+ /**
3153
+ * Emphasis is about highlighting certain data points in a chart.
3154
+ *
3155
+ * It can be defined for dimension values.
3156
+ * ```javascript
3157
+ *
3158
+ * Emphasis: {
3159
+ * DimensionValues: {
3160
+ * ...
3161
+ * }
3162
+ * }
3163
+ * ```
3164
+ * **For dimension values**
3165
+ *
3166
+ * Highlight a specified set of values of a dimension visible in the current chart layout. The qualitative
3167
+ * color palette is used.
3168
+ *
3169
+ * `'Values'` is used to specify dimension value(s) for highlight. `'Legend'` is used to customize legend
3170
+ * label whose `'Hightlighted'` is mandatory when multiple dimension values defined in `'Values'`.
3171
+ * ```javascript
3172
+ *
3173
+ * DimensionValues: {
3174
+ * 'dimensionName': {
3175
+ * Values: 'dimensionValue' or ['dimensionValue', ...],
3176
+ * Legend: {
3177
+ * Highlighted: string // mandatory for value array
3178
+ * Others: string // optional
3179
+ * }
3180
+ * },
3181
+ * 'dimensionName': {
3182
+ * ...
3183
+ * }
3184
+ * }
3185
+ * ```
3186
+ * Example:
3187
+ *
3188
+ * In this case, 'Germany' and 'France' are highlighted in 'Country' dimension with customized legend label
3189
+ * 'Europe'.
3190
+ * ```javascript
3191
+ *
3192
+ * var oColorings = {
3193
+ * Emphasis: {
3194
+ * DimensionValues: {
3195
+ * Country: {
3196
+ * Values: ['Germany', 'France']
3197
+ * Legend: 'Europe'
3198
+ * }
3199
+ * }
3200
+ * }
3201
+ * };
3202
+ * var oActiveColoring = {
3203
+ * coloring: sap.chart.ColoringType.Emphasis,
3204
+ * parameters: {
3205
+ * dimension: ['Country']
3206
+ * }
3207
+ * };
3208
+ * ```
3209
+ */
3210
+ Emphasis = "Emphasis",
3211
+ /**
3212
+ * Gradation introduces the notion of levels to visually separate chart elements by different hues of colors.
3213
+ *
3214
+ * Gradation coloring is based on predefined color palettes implementing one of the following color schemes:
3215
+ *
3216
+ * 1. Single-color scheme:
3217
+ *
3218
+ * Palette consists of a linear sequence of hues of the same color in increasing or decreasing saturation.
3219
+ * Every hue represents a level.
3220
+ *
3221
+ * 2. Diverging color scheme:
3222
+ *
3223
+ * Palette consists of two hues of different colors at the outer ends, and a linear sequence of other color
3224
+ * hues between them. Every color hue represents a level. The palette has a central mid area with an own
3225
+ * color separating the levels before and after the midpoint.
3226
+ *
3227
+ * 3. Target color scheme:
3228
+ *
3229
+ * Palette consists of two instances of a diverging color scheme palette, where the second is appended at
3230
+ * the end of the first with reverse order of hues. Every color hue represents a level. The palette has
3231
+ * a central midpoint for the target value positioned between the two palette instances, separating the
3232
+ * levels before and after the midpoint.
3233
+ *
3234
+ * Whether a gradation can be applied depends on the chart layout. The `Colorings.Gradation` object has
3235
+ * the overall structure:
3236
+ * ```javascript
3237
+ *
3238
+ * Gradation: {
3239
+ * RankedMeasureValues: { // Only for heatmap charts, if the measure is visible in the chart layout.
3240
+ * …
3241
+ * },
3242
+ * DelineatedMeasures: { // More than one of these measures is visible in the chart layout.
3243
+ * …
3244
+ * },
3245
+ * DelineatedDimensionValues: { // If the dimension is the only visible dimension in the chart layout and has the category role, or if the dimension is the only dimension with the series role.
3246
+ * …
3247
+ * }
3248
+ * }
3249
+ * ```
3250
+ *
3251
+ *
3252
+ * The option for ranked measure values can be specified for one or more measures identified by name:
3253
+ * ```javascript
3254
+ *
3255
+ * RankedMeasureValues: {
3256
+ * 'measureName': {
3257
+ * SingleColorScheme: {
3258
+ * Scheme: string, // enumeration: NoSemantics, Positive, Negative
3259
+ * Saturation: string, // enumeration: LightToDark, DarkToLight
3260
+ * NumberOfLevels: number, // between 2-6
3261
+ * RankingPerAggregationLevel: [
3262
+ * {
3263
+ * VisibleDimensions: [ 'dimensionName', … ],
3264
+ * LevelBoundaries: [ number, … ] // array with 1-5 numbers
3265
+ * },
3266
+ * …
3267
+ * ]
3268
+ * },
3269
+ * DivergingColorScheme: {
3270
+ * Scheme: string, // enumeration: NoSemantics, PositiveToNegative, NegativeToPositive, ColdToHot, HotToCold
3271
+ * NumberOfLevels: {
3272
+ * BelowMidArea: number, // between 2-6
3273
+ * AboveMidArea: number // between 2-6
3274
+ * },
3275
+ * RankingPerAggregationLevel: [
3276
+ * {
3277
+ * VisibleDimensions: [ 'dimensionName', … ],
3278
+ * MidAreaLowValue: number,
3279
+ * MidAreaHighValue: number
3280
+ * },
3281
+ * …
3282
+ * ]
3283
+ * },
3284
+ * TargetColorScheme: {
3285
+ * Scheme: string, // enumeration: PositiveTarget
3286
+ * NumberOfLevels: {
3287
+ * BelowTargetMidpoint: number, // between 2-6
3288
+ * AboveTargetMidpoint: number // between 2-6
3289
+ * },
3290
+ * RankingPerAggregationLevel: [
3291
+ * {
3292
+ * VisibleDimensions: [ 'dimensionName', … ],
3293
+ * TargetMidpoint: number
3294
+ * },
3295
+ * …
3296
+ * ]
3297
+ * },
3298
+ * },
3299
+ * 'measureName': { … },
3300
+ * ...
3301
+ * }
3302
+ * ```
3303
+ *
3304
+ *
3305
+ * For a single color scheme, Scheme names the scheme to be applied. If it is not specified, the default
3306
+ * is NoSemantics. The possible values of scheme name are listed in {@link sap.chart.coloring.GradationSingleColorScheme}.
3307
+ * If Saturation is not specified, the default is LightToDark. The possible values of saturation are listed
3308
+ * in {@link sap.chart.coloring.GradationSaturation}
3309
+ *
3310
+ * For an aggregation level specified by a list of visible dimensions, the level boundary array is a strictly
3311
+ * increasing sequence of numbers establishing a series of consecutive value intervals. In case VisibleDimensions
3312
+ * is omitted, the level boundaries are applied independent of the aggregation level in the current chart
3313
+ * layout.
3314
+ *
3315
+ * If RankingPerAggregationLevel is not provided, the chart will apply a default ranking by determining
3316
+ * the minimum and maximum value of the measure in the data set and cutting this value range into equally
3317
+ * sized intervals for the requested NumberOfLevels. If NumberOfLevels to be distinguished is not specified,
3318
+ * the default is 5 levels.
3319
+ *
3320
+ * Example: In this case, the values of 'Age' are ranked as 4 levels following the color scheme 'Positive'
3321
+ * from dark to light.
3322
+ * ```javascript
3323
+ *
3324
+ * var oColorings = {
3325
+ * Gradation: {
3326
+ * RankedMeasureValues: {
3327
+ * Age: {
3328
+ * SingleColorScheme : {
3329
+ * Scheme: 'Positive',
3330
+ * Saturation: 'DarkToLight',
3331
+ * RankingPerAggregationLevel: [
3332
+ * {
3333
+ * VisibleDimensions: ["Name"],
3334
+ * LevelBoundaries: [20, 25, 28]
3335
+ * }
3336
+ * ]
3337
+ * }
3338
+ * }
3339
+ * }
3340
+ * }
3341
+ * };
3342
+ * var oActiveColoring = {
3343
+ * coloring: sap.chart.ColoringType.Gradation
3344
+ * };
3345
+ * ```
3346
+ *
3347
+ *
3348
+ * For a diverging color scheme, Scheme names the scheme to be applied. If it is not specified, the default
3349
+ * is NoSemantics. The possible values of scheme name are listed in {@link sap.chart.coloring.GradationDivergingColorScheme}.
3350
+ *
3351
+ * A diverging color scheme circles around a mid area represented by a level on its own. Therefore, two
3352
+ * level counts are to be specified, one for the range of values below the mid area, and another for the
3353
+ * range above the mid area.
3354
+ *
3355
+ * For an aggregation level specified by a list of visible dimensions, the boundary values for the mid area
3356
+ * must be specified in MidAreaLowValue and MidAreaHighValue. If both values are equal, the mid area collapses
3357
+ * into a single point and the mid area level vanishes.
3358
+ *
3359
+ * The chart determines the minimum and maximum values from the data set. To cut the value range before
3360
+ * the mid area into the specified number of levels NumberOfLevels.BelowMidArea, the value interval from
3361
+ * the MidAreaLowValue down to the minimum value is divided into as many equally sized intervals. In the
3362
+ * same way, the value interval above the mid area is cut into the specified number of levels NumberOfLevels.AboveMidArea
3363
+ * above the mid area using the determined maximum value.
3364
+ *
3365
+ * In case VisibleDimensions is omitted, this ranking becomes the default and is applied independent of
3366
+ * the aggregation level in the current chart layout. Further entries in RankingPerAggregationLevel must
3367
+ * then include VisibleDimensions and are used to describe exceptions from the default ranking for the specified
3368
+ * aggregation level.
3369
+ *
3370
+ * Example: In this case, the values of 'Age' are ranked as 7 levels with a mid area [22, 27] following
3371
+ * the color scheme 'PositiveToNegative'.
3372
+ * ```javascript
3373
+ *
3374
+ * var oColorings = {
3375
+ * Gradation: {
3376
+ * RankedMeasureValues: {
3377
+ * Age: {
3378
+ * DivergingColorScheme : {
3379
+ * Scheme: 'PositiveToNegative',
3380
+ * NumberOfLevels: {
3381
+ * BelowMidArea: 3,
3382
+ * AboveMidArea: 3
3383
+ * },
3384
+ * RankingPerAggregationLevel: [
3385
+ * {
3386
+ * VisibleDimensions: ["Name"],
3387
+ * MidAreaLowValue: 22,
3388
+ * MidAreaHighValue: 27
3389
+ * }
3390
+ * ]
3391
+ * }
3392
+ * }
3393
+ * }
3394
+ * }
3395
+ * };
3396
+ * var oActiveColoring = {
3397
+ * coloring: sap.chart.ColoringType.Gradation
3398
+ * };
3399
+ * ```
3400
+ *
3401
+ *
3402
+ * For a target color scheme, Scheme names the scheme to be applied. If it is not specified, the default
3403
+ * is PositiveTarget. The possible values of scheme name are listed in {@link sap.chart.coloring.GradationTargetColorScheme}.
3404
+ *
3405
+ * For an aggregation level specified by a list of visible dimensions, the measure value to be used as target
3406
+ * midpoint must be specified in TargetMidpoint.
3407
+ *
3408
+ * The chart determines the minimum and maximum values from the data set. To cut the value range before
3409
+ * the target midpoint into the specified number of levels NumberOfLevels.BelowTargetMidPoint, the value
3410
+ * interval from the TargetMidpoint down to the minimum value is divided into as many equally sized intervals.
3411
+ * In the same way, the value interval above the midpoint is cut into the specified number of levels NumberOfLevels.AboveTargetMidPoint
3412
+ * above the midpoint using the determined maximum value.
3413
+ *
3414
+ * In case VisibleDimensions is omitted, the midpoint is applied independent of the aggregation level in
3415
+ * the current chart layout. Further entries in RankingPerAggregationLevel must then include VisibleDimensions
3416
+ * and are used to describe exceptions from the general midpoint for the specified aggregation level.
3417
+ *
3418
+ * Example: In this case, the values of 'Age' are ranked as 12 levels with a target mid point following
3419
+ * the color scheme 'PositiveTarget'.
3420
+ * ```javascript
3421
+ *
3422
+ * var oColorings = {
3423
+ * Gradation: {
3424
+ * RankedMeasureValues: {
3425
+ * Age: {
3426
+ * TargetColorScheme : {
3427
+ * Scheme: 'PositiveTarget',
3428
+ * NumberOfLevels: {
3429
+ * BelowTargetMidpoint: 6,
3430
+ * AboveTargetMidpoint: 6
3431
+ * },
3432
+ * RankingPerAggregationLevel: [
3433
+ * {
3434
+ * VisibleDimensions: ["Name"],
3435
+ * TargetMidpoint: 25
3436
+ * }
3437
+ * ]
3438
+ * }
3439
+ * }
3440
+ * }
3441
+ * }
3442
+ * };
3443
+ * var oActiveColoring = {
3444
+ * coloring: sap.chart.ColoringType.Gradation
3445
+ * };
3446
+ * ```
3447
+ *
3448
+ *
3449
+ * If no gradation has been specified for a measure (meaning: neither a single nor a diverging color nor
3450
+ * a target scheme), then the ranked measure values option still can be applied via activeColoring. In this
3451
+ * case, the default is a single-color scheme with defaults applied to all its component as described above.
3452
+ *
3453
+ * The option for delineated measures maps (between two and six) measures identified by name to gradation
3454
+ * levels, with increasing index numbers. It shall be applied only if the measures visible in the chart
3455
+ * are a subset of those specified here:
3456
+ * ```javascript
3457
+ *
3458
+ * DelineatedMeasures: {
3459
+ * SingleColorScheme: string, // enumeration of schemes-see above
3460
+ * Saturation: string, // enumeration: LightToDark, DarkToLight
3461
+ * Levels: [ 'measureName', … ] // between 2-6 members
3462
+ * }
3463
+ * ```
3464
+ *
3465
+ *
3466
+ * If the color scheme is not specified, the default is NoSemantic. If Saturation is not specified, the
3467
+ * default is LightToDark.
3468
+ *
3469
+ * If delineated measure gradation is to be shown, and if the chart layout contains further visible measures
3470
+ * not mentioned in the delineated measure configuration, then gradation coloring must not be applied.
3471
+ *
3472
+ * Example: In this case, the value of 'Win', 'Draw' and 'Lose' are shown in 3 color levels.
3473
+ * ```javascript
3474
+ *
3475
+ * var oColorings = {
3476
+ * Gradation: {
3477
+ * DelineatedMeasures: {
3478
+ * SingleColorScheme: 'PositiveTarget',
3479
+ * Saturation: 'DarkToLight',
3480
+ * Levels: ['Win', 'Draw', 'Lose']
3481
+ * }
3482
+ * }
3483
+ * };
3484
+ * var oActiveColoring = {
3485
+ * coloring: sap.chart.ColoringType.Gradation
3486
+ * };
3487
+ * ```
3488
+ *
3489
+ *
3490
+ * The option for delineated dimension values can map (between two and six) dimension values to gradation
3491
+ * levels, with increasing index numbers. It shall be applied only if the data set to be visualized contains
3492
+ * no dimension values other than those specified.
3493
+ * ```javascript
3494
+ *
3495
+ * DelineatedDimensionValues: {
3496
+ * SingleColorScheme: string, // enumeration of schemes-see above
3497
+ * Saturation: string, // enumeration: LightToDark, DarkToLight
3498
+ * 'dimensionName': {
3499
+ * Levels: [ 'dimensionValue', … ] // between 2-6 members
3500
+ * },
3501
+ * 'dimensionName': {...},
3502
+ * ...
3503
+ * }
3504
+ * ```
3505
+ *
3506
+ *
3507
+ * If color scheme is not specified, the default is NoSemantic. If Saturation is not specified, the default
3508
+ * is LightToDark.
3509
+ *
3510
+ * If delineated dimension value gradation is to be shown, and the “data” model contains dimension values
3511
+ * not mentioned in the configuration, then gradation coloring must not be applied.
3512
+ *
3513
+ * Example: In this case, the measures mapping to the dimension value 'Injured', 'Normal', 'Superb' and
3514
+ * 'Tired' are shown in 4 color levels.
3515
+ * ```javascript
3516
+ *
3517
+ * var oColorings = {
3518
+ * Gradation: {
3519
+ * DelineatedDimensionValues: {
3520
+ * SingleColorScheme: 'PositiveTarget',
3521
+ * Saturation: 'DarkToLight',
3522
+ * Fitness: {
3523
+ * Levels: ['Injured', 'Normal', 'Superb', 'Tired']
3524
+ * }
3525
+ * }
3526
+ * }
3527
+ * };
3528
+ * var oActiveColoring = {
3529
+ * coloring: sap.chart.ColoringType.Gradation
3530
+ * };
3531
+ * ```
3532
+ */
3533
+ Gradation = "Gradation",
3534
+ }
3535
+ export default ColoringType;
3536
+ }
3537
+
3538
+ declare module "sap/chart/data/Dimension" {
3539
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
3540
+
3541
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
3542
+
3543
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3544
+
3545
+ /**
3546
+ * @SINCE 1.32.0
3547
+ *
3548
+ * Definition of a single dimension in a chart
3549
+ *
3550
+ * chartType binding rules pie, donut All
3551
+ * dimensions are assigned to feed uid “color”. scatter, bubble All dimensions
3552
+ * with role category are assigned to feed uid “shape”. heatmap All dimensions
3553
+ * with role “series” and “category2” are assigned to the feed uid “categoryAxis2”. treemap
3554
+ * All dimensions are assigned to the feed uid “categoryAxis” in the default sequence.
3555
+ */
3556
+ export default class Dimension extends UI5Element {
3557
+ /**
3558
+ * Constructor for a new ui5/data/Dimension.
3559
+ *
3560
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3561
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3562
+ * of the syntax of the settings object.
3563
+ */
3564
+ constructor(
3565
+ /**
3566
+ * initial settings for the new control
3567
+ */
3568
+ mSettings?: $DimensionSettings
3569
+ );
3570
+ /**
3571
+ * Constructor for a new ui5/data/Dimension.
3572
+ *
3573
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3574
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3575
+ * of the syntax of the settings object.
3576
+ */
3577
+ constructor(
3578
+ /**
3579
+ * id for the new control, generated automatically if no id is given
3580
+ */
3581
+ sId?: string,
3582
+ /**
3583
+ * initial settings for the new control
3584
+ */
3585
+ mSettings?: $DimensionSettings
3586
+ );
3587
+
3588
+ /**
3589
+ * Creates a new subclass of class sap.chart.data.Dimension with name `sClassName` and enriches it with
3590
+ * the information contained in `oClassInfo`.
3591
+ *
3592
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
3593
+ *
3594
+ * @returns Created class / constructor function
3595
+ */
3596
+ static extend<T extends Record<string, unknown>>(
3597
+ /**
3598
+ * Name of the class being created
3599
+ */
3600
+ sClassName: string,
3601
+ /**
3602
+ * Object literal with information about the class
3603
+ */
3604
+ oClassInfo?: sap.ClassInfo<T, Dimension>,
3605
+ /**
3606
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3607
+ * used by this class
3608
+ */
3609
+ FNMetaImpl?: Function
3610
+ ): Function;
3611
+ /**
3612
+ * Returns a metadata object for class sap.chart.data.Dimension.
3613
+ *
3614
+ * @returns Metadata object describing this class
3615
+ */
3616
+ static getMetadata(): ElementMetadata;
3617
+ /**
3618
+ * Gets current value of property {@link #getDisplayText displayText}.
3619
+ *
3620
+ * Whether a text is displayed. If the "textProperty" property has not been specified, it will be derived
3621
+ * from the metadata.
3622
+ *
3623
+ * Default value is `true`.
3624
+ *
3625
+ * @returns Value of property `displayText`
3626
+ */
3627
+ getDisplayText(): boolean;
3628
+ /**
3629
+ * Gets current value of property {@link #getLabel label}.
3630
+ *
3631
+ * Label for the Dimension, either as a string literal or by a pointer using the binding syntax to some
3632
+ * property containing the label.
3633
+ *
3634
+ * **NOTE:** This property was bound internally if automatically created via metadata of oData service and
3635
+ * please call "unbindProperty" before setting.
3636
+ *
3637
+ * @returns Value of property `label`
3638
+ */
3639
+ getLabel(): string;
3640
+ /**
3641
+ * Gets current value of property {@link #getName name}.
3642
+ *
3643
+ * Property in the "data" model holding the (always unique) Dimension key.
3644
+ *
3645
+ * @returns Value of property `name`
3646
+ */
3647
+ getName(): string;
3648
+ /**
3649
+ * Gets current value of property {@link #getRole role}.
3650
+ *
3651
+ * How the Dimension will influence the chart layout. Possible values are {@link sap.chart.data.DimensionRoleType
3652
+ * category}, {@link sap.chart.data.DimensionRoleType series} or {@link sap.chart.data.DimensionRoleType
3653
+ * category2}. The default is {@link sap.chart.data.DimensionRoleType category}.
3654
+ *
3655
+ * You can create a new dimension as follow:
3656
+ * ```javascript
3657
+ *
3658
+ * ...
3659
+ * new sap.chart.data.Dimension({name: "DIMENSION1", role: sap.chart.data.DimensionRoleType.category})
3660
+ * ...
3661
+ * ```
3662
+ *
3663
+ *
3664
+ * Detailed usage of dimension role. Please refer to {@link sap.chart.data.DimensionRoleType DimensionRoleType}
3665
+ *
3666
+ * **NOTE:** Has no effect if the Dimension is used as inResultDimensions by Chart
3667
+ *
3668
+ * Default value is `"category"`.
3669
+ *
3670
+ * @returns Value of property `role`
3671
+ */
3672
+ getRole(): string;
3673
+ /**
3674
+ * Gets current value of property {@link #getTextFormatter textFormatter}.
3675
+ *
3676
+ * Function returning a formatted text for a Dimension key value that will be used for axis labelling. If
3677
+ * specified, this property takes precedence over the "textProperty" property of the Dimension. Dimension
3678
+ * key value and the corresponding text will be passed to the supplied function as parameters.
3679
+ *
3680
+ * @returns Value of property `textFormatter`
3681
+ */
3682
+ getTextFormatter(): Function;
3683
+ /**
3684
+ * Gets current value of property {@link #getTextProperty textProperty}.
3685
+ *
3686
+ * Text for a Dimension key value, typically by a pointer using the binding syntax to some property containing
3687
+ * the text.
3688
+ *
3689
+ * **NOTE:** This property was bound internally if automatically created via metadata of oData service and
3690
+ * please call "unbindProperty" before setting.
3691
+ *
3692
+ * @returns Value of property `textProperty`
3693
+ */
3694
+ getTextProperty(): string;
3695
+ /**
3696
+ * Sets a new value for property {@link #getDisplayText displayText}.
3697
+ *
3698
+ * Whether a text is displayed. If the "textProperty" property has not been specified, it will be derived
3699
+ * from the metadata.
3700
+ *
3701
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3702
+ *
3703
+ * Default value is `true`.
3704
+ *
3705
+ * @returns Reference to `this` in order to allow method chaining
3706
+ */
3707
+ setDisplayText(
3708
+ /**
3709
+ * New value for property `displayText`
3710
+ */
3711
+ bDisplayText?: boolean
3712
+ ): this;
3713
+ /**
3714
+ * Sets a new value for property {@link #getLabel label}.
3715
+ *
3716
+ * Label for the Dimension, either as a string literal or by a pointer using the binding syntax to some
3717
+ * property containing the label.
3718
+ *
3719
+ * **NOTE:** This property was bound internally if automatically created via metadata of oData service and
3720
+ * please call "unbindProperty" before setting.
3721
+ *
3722
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3723
+ *
3724
+ * @returns Reference to `this` in order to allow method chaining
3725
+ */
3726
+ setLabel(
3727
+ /**
3728
+ * New value for property `label`
3729
+ */
3730
+ sLabel: string
3731
+ ): this;
3732
+ /**
3733
+ * Sets a new value for property {@link #getName name}.
3734
+ *
3735
+ * Property in the "data" model holding the (always unique) Dimension key.
3736
+ *
3737
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3738
+ *
3739
+ * @returns Reference to `this` in order to allow method chaining
3740
+ */
3741
+ setName(
3742
+ /**
3743
+ * New value for property `name`
3744
+ */
3745
+ sName: string
3746
+ ): this;
3747
+ /**
3748
+ * Sets a new value for property {@link #getRole role}.
3749
+ *
3750
+ * How the Dimension will influence the chart layout. Possible values are {@link sap.chart.data.DimensionRoleType
3751
+ * category}, {@link sap.chart.data.DimensionRoleType series} or {@link sap.chart.data.DimensionRoleType
3752
+ * category2}. The default is {@link sap.chart.data.DimensionRoleType category}.
3753
+ *
3754
+ * You can create a new dimension as follow:
3755
+ * ```javascript
3756
+ *
3757
+ * ...
3758
+ * new sap.chart.data.Dimension({name: "DIMENSION1", role: sap.chart.data.DimensionRoleType.category})
3759
+ * ...
3760
+ * ```
3761
+ *
3762
+ *
3763
+ * Detailed usage of dimension role. Please refer to {@link sap.chart.data.DimensionRoleType DimensionRoleType}
3764
+ *
3765
+ * **NOTE:** Has no effect if the Dimension is used as inResultDimensions by Chart
3766
+ *
3767
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3768
+ *
3769
+ * Default value is `"category"`.
3770
+ *
3771
+ * @returns Reference to `this` in order to allow method chaining
3772
+ */
3773
+ setRole(
3774
+ /**
3775
+ * New value for property `role`
3776
+ */
3777
+ sRole?: string
3778
+ ): this;
3779
+ /**
3780
+ * Sets a new value for property {@link #getTextFormatter textFormatter}.
3781
+ *
3782
+ * Function returning a formatted text for a Dimension key value that will be used for axis labelling. If
3783
+ * specified, this property takes precedence over the "textProperty" property of the Dimension. Dimension
3784
+ * key value and the corresponding text will be passed to the supplied function as parameters.
3785
+ *
3786
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3787
+ *
3788
+ * @returns Reference to `this` in order to allow method chaining
3789
+ */
3790
+ setTextFormatter(
3791
+ /**
3792
+ * New value for property `textFormatter`
3793
+ */
3794
+ fnTextFormatter: Function
3795
+ ): this;
3796
+ /**
3797
+ * Sets a new value for property {@link #getTextProperty textProperty}.
3798
+ *
3799
+ * Text for a Dimension key value, typically by a pointer using the binding syntax to some property containing
3800
+ * the text.
3801
+ *
3802
+ * **NOTE:** This property was bound internally if automatically created via metadata of oData service and
3803
+ * please call "unbindProperty" before setting.
3804
+ *
3805
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3806
+ *
3807
+ * @returns Reference to `this` in order to allow method chaining
3808
+ */
3809
+ setTextProperty(
3810
+ /**
3811
+ * New value for property `textProperty`
3812
+ */
3813
+ sTextProperty: string
3814
+ ): this;
3815
+ }
3816
+
3817
+ export interface $DimensionSettings extends $ElementSettings {
3818
+ /**
3819
+ * Property in the "data" model holding the (always unique) Dimension key.
3820
+ */
3821
+ name?: string | PropertyBindingInfo;
3822
+
3823
+ /**
3824
+ * Label for the Dimension, either as a string literal or by a pointer using the binding syntax to some
3825
+ * property containing the label.
3826
+ *
3827
+ * **NOTE:** This property was bound internally if automatically created via metadata of oData service and
3828
+ * please call "unbindProperty" before setting.
3829
+ */
3830
+ label?: string | PropertyBindingInfo;
3831
+
3832
+ /**
3833
+ * Function returning a formatted text for a Dimension key value that will be used for axis labelling. If
3834
+ * specified, this property takes precedence over the "textProperty" property of the Dimension. Dimension
3835
+ * key value and the corresponding text will be passed to the supplied function as parameters.
3836
+ */
3837
+ textFormatter?: Function | PropertyBindingInfo | `{${string}}`;
3838
+
3839
+ /**
3840
+ * Text for a Dimension key value, typically by a pointer using the binding syntax to some property containing
3841
+ * the text.
3842
+ *
3843
+ * **NOTE:** This property was bound internally if automatically created via metadata of oData service and
3844
+ * please call "unbindProperty" before setting.
3845
+ */
3846
+ textProperty?: string | PropertyBindingInfo;
3847
+
3848
+ /**
3849
+ * Whether a text is displayed. If the "textProperty" property has not been specified, it will be derived
3850
+ * from the metadata.
3851
+ */
3852
+ displayText?: boolean | PropertyBindingInfo | `{${string}}`;
3853
+
3854
+ /**
3855
+ * How the Dimension will influence the chart layout. Possible values are {@link sap.chart.data.DimensionRoleType
3856
+ * category}, {@link sap.chart.data.DimensionRoleType series} or {@link sap.chart.data.DimensionRoleType
3857
+ * category2}. The default is {@link sap.chart.data.DimensionRoleType category}.
3858
+ *
3859
+ * You can create a new dimension as follow:
3860
+ * ```javascript
3861
+ *
3862
+ * ...
3863
+ * new sap.chart.data.Dimension({name: "DIMENSION1", role: sap.chart.data.DimensionRoleType.category})
3864
+ * ...
3865
+ * ```
3866
+ *
3867
+ *
3868
+ * Detailed usage of dimension role. Please refer to {@link sap.chart.data.DimensionRoleType DimensionRoleType}
3869
+ *
3870
+ * **NOTE:** Has no effect if the Dimension is used as inResultDimensions by Chart
3871
+ */
3872
+ role?: string | PropertyBindingInfo;
3873
+ }
3874
+ }
3875
+
3876
+ declare module "sap/chart/data/DimensionRoleType" {
3877
+ /**
3878
+ * Enum of supported role types for Dimension
3879
+ */
3880
+ enum DimensionRoleType {
3881
+ /**
3882
+ * All dimensions with role "category" are assigned to the feed uid "categoryAxis".
3883
+ *
3884
+ * **NOTE:** If the chart type requires at least one dimension on the feed "categoryAxis" (true for all
3885
+ * chart types except pie and donut), but no dimension has the role "category" or "category2", then the
3886
+ * first visible dimension is assigned to the "categoryAxis".
3887
+ */
3888
+ category = "category",
3889
+ /**
3890
+ * If a chart type does not use the feed uid "categoryAxis2", then all dimensions with role "category2"
3891
+ * are treated as dimension with role "category" (appended).
3892
+ */
3893
+ category2 = "category2",
3894
+ /**
3895
+ * All dimensions with role "series" are assigned to the feed uid "color".
3896
+ */
3897
+ series = "series",
3898
+ }
3899
+ export default DimensionRoleType;
3900
+ }
3901
+
3902
+ declare module "sap/chart/data/HierarchyDimension" {
3903
+ import {
3904
+ default as Dimension,
3905
+ $DimensionSettings,
3906
+ } from "sap/chart/data/Dimension";
3907
+
3908
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
3909
+
3910
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3911
+
3912
+ /**
3913
+ * @SINCE 1.54.0
3914
+ *
3915
+ * Definition of a single hierarchy dimension in a chart
3916
+ */
3917
+ export default class HierarchyDimension extends Dimension {
3918
+ /**
3919
+ * Constructor for a new ui5/data/HierarchyDimension.
3920
+ *
3921
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3922
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3923
+ * of the syntax of the settings object.
3924
+ */
3925
+ constructor(
3926
+ /**
3927
+ * initial settings for the new control
3928
+ */
3929
+ mSettings?: $HierarchyDimensionSettings
3930
+ );
3931
+ /**
3932
+ * Constructor for a new ui5/data/HierarchyDimension.
3933
+ *
3934
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3935
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3936
+ * of the syntax of the settings object.
3937
+ */
3938
+ constructor(
3939
+ /**
3940
+ * id for the new control, generated automatically if no id is given
3941
+ */
3942
+ sId?: string,
3943
+ /**
3944
+ * initial settings for the new control
3945
+ */
3946
+ mSettings?: $HierarchyDimensionSettings
3947
+ );
3948
+
3949
+ /**
3950
+ * Creates a new subclass of class sap.chart.data.HierarchyDimension with name `sClassName` and enriches
3951
+ * it with the information contained in `oClassInfo`.
3952
+ *
3953
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.chart.data.Dimension.extend}.
3954
+ *
3955
+ * @returns Created class / constructor function
3956
+ */
3957
+ static extend<T extends Record<string, unknown>>(
3958
+ /**
3959
+ * Name of the class being created
3960
+ */
3961
+ sClassName: string,
3962
+ /**
3963
+ * Object literal with information about the class
3964
+ */
3965
+ oClassInfo?: sap.ClassInfo<T, HierarchyDimension>,
3966
+ /**
3967
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3968
+ * used by this class
3969
+ */
3970
+ FNMetaImpl?: Function
3971
+ ): Function;
3972
+ /**
3973
+ * Returns a metadata object for class sap.chart.data.HierarchyDimension.
3974
+ *
3975
+ * @returns Metadata object describing this class
3976
+ */
3977
+ static getMetadata(): ElementMetadata;
3978
+ /**
3979
+ * Gets current value of property {@link #getLevel level}.
3980
+ *
3981
+ * Level restriction to be applied to this hierarchy dimension. NOTE: Setting this property will cause initialization
3982
+ * of drill stack. Getter of this property just returns level explicitly set by user, call {@link sap.chart.Chart#getDrillStack}
3983
+ * and refer to 'hierarchylevel' if you need current level after drilling
3984
+ *
3985
+ * Default value is `0`.
3986
+ *
3987
+ * @returns Value of property `level`
3988
+ */
3989
+ getLevel(): int;
3990
+ /**
3991
+ * Sets a new value for property {@link #getLevel level}.
3992
+ *
3993
+ * Level restriction to be applied to this hierarchy dimension. NOTE: Setting this property will cause initialization
3994
+ * of drill stack. Getter of this property just returns level explicitly set by user, call {@link sap.chart.Chart#getDrillStack}
3995
+ * and refer to 'hierarchylevel' if you need current level after drilling
3996
+ *
3997
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3998
+ *
3999
+ * Default value is `0`.
4000
+ *
4001
+ * @returns Reference to `this` in order to allow method chaining
4002
+ */
4003
+ setLevel(
4004
+ /**
4005
+ * New value for property `level`
4006
+ */
4007
+ iLevel?: int
4008
+ ): this;
4009
+ }
4010
+
4011
+ export interface $HierarchyDimensionSettings extends $DimensionSettings {
4012
+ /**
4013
+ * Level restriction to be applied to this hierarchy dimension. NOTE: Setting this property will cause initialization
4014
+ * of drill stack. Getter of this property just returns level explicitly set by user, call {@link sap.chart.Chart#getDrillStack}
4015
+ * and refer to 'hierarchylevel' if you need current level after drilling
4016
+ */
4017
+ level?: int | PropertyBindingInfo | `{${string}}`;
4018
+ }
4019
+ }
4020
+
4021
+ declare module "sap/chart/data/Measure" {
4022
+ import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
4023
+
4024
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
4025
+
4026
+ import MeasureSemantics from "sap/chart/data/MeasureSemantics";
4027
+
4028
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
4029
+
4030
+ /**
4031
+ * @SINCE 1.32.0
4032
+ *
4033
+ * Definition of a single measure in a chart
4034
+ *
4035
+ * chartType binding rules pie, donut The
4036
+ * measure is assigned to feed uid “size”. scatter The first measure with role
4037
+ * “axis1”, or (if not exists) the first measure with role “axis2” or (if not exist) with role “axis3”,
4038
+ * is assigned to the feed uid “valueAxis”. The other measure is assigned to feed uid “valueAxis2”.
4039
+ * bubble The first measure with role “axis1”, or (if not exists) the first measure
4040
+ * with role “axis2” or (if not exist) with role “axis3”, is assigned to the feed uid “valueAxis”.
4041
+ * The first measure with role “axis2”, or (if not exists) the second measure with role “axis1” or (if not
4042
+ * exist) the first measure with role “axis3”, is assigned to the feed uid “valueAxis2”.
4043
+ * The remaining measure is assigned to feed uid “bubbleWidth”. heatmap The
4044
+ * measure is assigned to the feed uid “color”. treemap The first measure with
4045
+ * role “axis1”, or (if not exists) the first measure with role “axis2” or (if not exist) with role “axis3”,
4046
+ * is assigned to the feed uid “color”. The other measure is assigned to feed uid “weight”.
4047
+ * ..dual.. At least one measure is assigned to each of the feed uids “valueAxis” and “valueAxis2”,
4048
+ * according to the general rule.
4049
+ */
4050
+ export default class Measure extends UI5Element {
4051
+ /**
4052
+ * Constructor for a new ui5/data/Measure.
4053
+ *
4054
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
4055
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
4056
+ * of the syntax of the settings object.
4057
+ */
4058
+ constructor(
4059
+ /**
4060
+ * initial settings for the new control
4061
+ */
4062
+ mSettings?: $MeasureSettings
4063
+ );
4064
+ /**
4065
+ * Constructor for a new ui5/data/Measure.
4066
+ *
4067
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
4068
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
4069
+ * of the syntax of the settings object.
4070
+ */
4071
+ constructor(
4072
+ /**
4073
+ * id for the new control, generated automatically if no id is given
4074
+ */
4075
+ sId?: string,
4076
+ /**
4077
+ * initial settings for the new control
4078
+ */
4079
+ mSettings?: $MeasureSettings
4080
+ );
4081
+
4082
+ /**
4083
+ * Creates a new subclass of class sap.chart.data.Measure with name `sClassName` and enriches it with the
4084
+ * information contained in `oClassInfo`.
4085
+ *
4086
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
4087
+ *
4088
+ * @returns Created class / constructor function
4089
+ */
4090
+ static extend<T extends Record<string, unknown>>(
4091
+ /**
4092
+ * Name of the class being created
4093
+ */
4094
+ sClassName: string,
4095
+ /**
4096
+ * Object literal with information about the class
4097
+ */
4098
+ oClassInfo?: sap.ClassInfo<T, Measure>,
4099
+ /**
4100
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
4101
+ * used by this class
4102
+ */
4103
+ FNMetaImpl?: Function
4104
+ ): Function;
4105
+ /**
4106
+ * Returns a metadata object for class sap.chart.data.Measure.
4107
+ *
4108
+ * @returns Metadata object describing this class
4109
+ */
4110
+ static getMetadata(): ElementMetadata;
4111
+ /**
4112
+ * @SINCE 1.63
4113
+ * @EXPERIMENTAL
4114
+ *
4115
+ * Gets current value of property {@link #getAnalyticalInfo analyticalInfo}.
4116
+ *
4117
+ * The analytical extra information
4118
+ *
4119
+ * @returns Value of property `analyticalInfo`
4120
+ */
4121
+ getAnalyticalInfo(): object;
4122
+ /**
4123
+ * Gets current value of property {@link #getLabel label}.
4124
+ *
4125
+ * Label for the Measure, either as a string literal or by a pointer using the binding syntax to some property
4126
+ * containing the label.
4127
+ *
4128
+ * @returns Value of property `label`
4129
+ */
4130
+ getLabel(): string;
4131
+ /**
4132
+ * Gets current value of property {@link #getName name}.
4133
+ *
4134
+ * Property in the "data" model holding the raw measure value.
4135
+ *
4136
+ * @returns Value of property `name`
4137
+ */
4138
+ getName(): string;
4139
+ /**
4140
+ * Gets current value of property {@link #getRole role}.
4141
+ *
4142
+ * How values of Measure will be rendered in the chart. Possible role values are {@link sap.chart.data.MeasureRoleType
4143
+ * axis1}, {@link sap.chart.data.MeasureRoleType axis2}, {@link sap.chart.data.MeasureRoleType axis3}, and
4144
+ * {@link sap.chart.data.MeasureRoleType axis4}. The default is {@link sap.chart.data.MeasureRoleType axis1}.
4145
+ * They correspond to the well-known concepts of axis identifiers in the Cartesian coordinate system, e.g.
4146
+ * a Y-axis in a bar/column/line chart, an X- and a Y-axis in a scatter chart, or two Y-axes in bar charts,
4147
+ * and an optional third axis for the weight/size/intensity/temperature of a data point.
4148
+ *
4149
+ * You can create a new measure as follow:
4150
+ * ```javascript
4151
+ *
4152
+ * ...
4153
+ * new sap.chart.data.Measure({name: "MEASURE1", role: sap.chart.data.MeasureRoleType.axis1})
4154
+ * ...
4155
+ * ```
4156
+ *
4157
+ *
4158
+ * Detailed usage of measure role. Please refer to {@link sap.chart.data.MeasureRoleType MeasureRoleType}
4159
+ *
4160
+ * **NOTE:** Role definition would not work for Bullet Chart and users need to set semantics instead.
4161
+ *
4162
+ * Default value is `"axis1"`.
4163
+ *
4164
+ * @returns Value of property `role`
4165
+ */
4166
+ getRole(): string;
4167
+ /**
4168
+ * Gets current value of property {@link #getSemanticallyRelatedMeasures semanticallyRelatedMeasures}.
4169
+ *
4170
+ * Semantically related measures for a measure with semantics "actual" value. It is an object with two properties:
4171
+ *
4172
+ * - "projectedValueMeasure" identifing the projected value measure, and
4173
+ * - "referenceValueMeasure" identifing the reference value measure.
4174
+ *
4175
+ * @returns Value of property `semanticallyRelatedMeasures`
4176
+ */
4177
+ getSemanticallyRelatedMeasures(): object;
4178
+ /**
4179
+ * Gets current value of property {@link #getSemantics semantics}.
4180
+ *
4181
+ * The semantics of the measure.
4182
+ *
4183
+ * **NOTE:** Dimension-based coloring (see {@link sap.chart.Chart#setColorings}) does not work when semantics
4184
+ * is set to {@link sap.chart.data.MeasureSemantics.Projected} or {@link sap.chart.data.MeasureSemantics.Reference}
4185
+ * for visible measure(s).
4186
+ *
4187
+ * **NOTE:** In Bullet chart measure defined as "Reference" maps to targetValues and "Projected" maps to
4188
+ * additionalValues. Measures without definition will be recognized as actualValues.
4189
+ *
4190
+ * Default value is `Actual`.
4191
+ *
4192
+ * @returns Value of property `semantics`
4193
+ */
4194
+ getSemantics(): MeasureSemantics;
4195
+ /**
4196
+ * Gets current value of property {@link #getUnitBinding unitBinding}.
4197
+ *
4198
+ * Unit for the measure, a pointer using the binding syntax to some field containing the unit. Value of
4199
+ * the given field from the same data record will be displayed after formatted measure value in data label,
4200
+ * tooltip and chart popover. NOTE: To work properly, the unit field must be set as visible dimension in
4201
+ * chart, and only one unit value exists for any visible dimension value combination.
4202
+ *
4203
+ * @returns Value of property `unitBinding`
4204
+ */
4205
+ getUnitBinding(): string;
4206
+ /**
4207
+ * @deprecated - Please use {@link sap.chart.Chart#setVizProperties} to set related formatStrings instead.
4208
+ *
4209
+ * Gets current value of property {@link #getValueFormat valueFormat}.
4210
+ *
4211
+ * A (core UI5) format pattern to be used by the formatter to format the measure value.
4212
+ *
4213
+ * @returns Value of property `valueFormat`
4214
+ */
4215
+ getValueFormat(): string;
4216
+ /**
4217
+ * @SINCE 1.63
4218
+ * @EXPERIMENTAL
4219
+ *
4220
+ * Sets a new value for property {@link #getAnalyticalInfo analyticalInfo}.
4221
+ *
4222
+ * The analytical extra information
4223
+ *
4224
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4225
+ *
4226
+ * @returns Reference to `this` in order to allow method chaining
4227
+ */
4228
+ setAnalyticalInfo(
4229
+ /**
4230
+ * New value for property `analyticalInfo`
4231
+ */
4232
+ oAnalyticalInfo?: object
4233
+ ): this;
4234
+ /**
4235
+ * Sets a new value for property {@link #getLabel label}.
4236
+ *
4237
+ * Label for the Measure, either as a string literal or by a pointer using the binding syntax to some property
4238
+ * containing the label.
4239
+ *
4240
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4241
+ *
4242
+ * @returns Reference to `this` in order to allow method chaining
4243
+ */
4244
+ setLabel(
4245
+ /**
4246
+ * New value for property `label`
4247
+ */
4248
+ sLabel: string
4249
+ ): this;
4250
+ /**
4251
+ * Sets a new value for property {@link #getName name}.
4252
+ *
4253
+ * Property in the "data" model holding the raw measure value.
4254
+ *
4255
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4256
+ *
4257
+ * @returns Reference to `this` in order to allow method chaining
4258
+ */
4259
+ setName(
4260
+ /**
4261
+ * New value for property `name`
4262
+ */
4263
+ sName: string
4264
+ ): this;
4265
+ /**
4266
+ * Sets a new value for property {@link #getRole role}.
4267
+ *
4268
+ * How values of Measure will be rendered in the chart. Possible role values are {@link sap.chart.data.MeasureRoleType
4269
+ * axis1}, {@link sap.chart.data.MeasureRoleType axis2}, {@link sap.chart.data.MeasureRoleType axis3}, and
4270
+ * {@link sap.chart.data.MeasureRoleType axis4}. The default is {@link sap.chart.data.MeasureRoleType axis1}.
4271
+ * They correspond to the well-known concepts of axis identifiers in the Cartesian coordinate system, e.g.
4272
+ * a Y-axis in a bar/column/line chart, an X- and a Y-axis in a scatter chart, or two Y-axes in bar charts,
4273
+ * and an optional third axis for the weight/size/intensity/temperature of a data point.
4274
+ *
4275
+ * You can create a new measure as follow:
4276
+ * ```javascript
4277
+ *
4278
+ * ...
4279
+ * new sap.chart.data.Measure({name: "MEASURE1", role: sap.chart.data.MeasureRoleType.axis1})
4280
+ * ...
4281
+ * ```
4282
+ *
4283
+ *
4284
+ * Detailed usage of measure role. Please refer to {@link sap.chart.data.MeasureRoleType MeasureRoleType}
4285
+ *
4286
+ * **NOTE:** Role definition would not work for Bullet Chart and users need to set semantics instead.
4287
+ *
4288
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4289
+ *
4290
+ * Default value is `"axis1"`.
4291
+ *
4292
+ * @returns Reference to `this` in order to allow method chaining
4293
+ */
4294
+ setRole(
4295
+ /**
4296
+ * New value for property `role`
4297
+ */
4298
+ sRole?: string
4299
+ ): this;
4300
+ /**
4301
+ * Sets a new value for property {@link #getSemanticallyRelatedMeasures semanticallyRelatedMeasures}.
4302
+ *
4303
+ * Semantically related measures for a measure with semantics "actual" value. It is an object with two properties:
4304
+ *
4305
+ * - "projectedValueMeasure" identifing the projected value measure, and
4306
+ * - "referenceValueMeasure" identifing the reference value measure.
4307
+ *
4308
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4309
+ *
4310
+ * @returns Reference to `this` in order to allow method chaining
4311
+ */
4312
+ setSemanticallyRelatedMeasures(
4313
+ /**
4314
+ * New value for property `semanticallyRelatedMeasures`
4315
+ */
4316
+ oSemanticallyRelatedMeasures?: object
4317
+ ): this;
4318
+ /**
4319
+ * Sets a new value for property {@link #getSemantics semantics}.
4320
+ *
4321
+ * The semantics of the measure.
4322
+ *
4323
+ * **NOTE:** Dimension-based coloring (see {@link sap.chart.Chart#setColorings}) does not work when semantics
4324
+ * is set to {@link sap.chart.data.MeasureSemantics.Projected} or {@link sap.chart.data.MeasureSemantics.Reference}
4325
+ * for visible measure(s).
4326
+ *
4327
+ * **NOTE:** In Bullet chart measure defined as "Reference" maps to targetValues and "Projected" maps to
4328
+ * additionalValues. Measures without definition will be recognized as actualValues.
4329
+ *
4330
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4331
+ *
4332
+ * Default value is `Actual`.
4333
+ *
4334
+ * @returns Reference to `this` in order to allow method chaining
4335
+ */
4336
+ setSemantics(
4337
+ /**
4338
+ * New value for property `semantics`
4339
+ */
4340
+ sSemantics?: MeasureSemantics
4341
+ ): this;
4342
+ /**
4343
+ * Sets a new value for property {@link #getUnitBinding unitBinding}.
4344
+ *
4345
+ * Unit for the measure, a pointer using the binding syntax to some field containing the unit. Value of
4346
+ * the given field from the same data record will be displayed after formatted measure value in data label,
4347
+ * tooltip and chart popover. NOTE: To work properly, the unit field must be set as visible dimension in
4348
+ * chart, and only one unit value exists for any visible dimension value combination.
4349
+ *
4350
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4351
+ *
4352
+ * @returns Reference to `this` in order to allow method chaining
4353
+ */
4354
+ setUnitBinding(
4355
+ /**
4356
+ * New value for property `unitBinding`
4357
+ */
4358
+ sUnitBinding: string
4359
+ ): this;
4360
+ /**
4361
+ * @deprecated - Please use {@link sap.chart.Chart#setVizProperties} to set related formatStrings instead.
4362
+ *
4363
+ * Sets a new value for property {@link #getValueFormat valueFormat}.
4364
+ *
4365
+ * A (core UI5) format pattern to be used by the formatter to format the measure value.
4366
+ *
4367
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4368
+ *
4369
+ * @returns Reference to `this` in order to allow method chaining
4370
+ */
4371
+ setValueFormat(
4372
+ /**
4373
+ * New value for property `valueFormat`
4374
+ */
4375
+ sValueFormat?: string
4376
+ ): this;
4377
+ }
4378
+
4379
+ export interface $MeasureSettings extends $ElementSettings {
4380
+ /**
4381
+ * Property in the "data" model holding the raw measure value.
4382
+ */
4383
+ name?: string | PropertyBindingInfo;
4384
+
4385
+ /**
4386
+ * Label for the Measure, either as a string literal or by a pointer using the binding syntax to some property
4387
+ * containing the label.
4388
+ */
4389
+ label?: string | PropertyBindingInfo;
4390
+
4391
+ /**
4392
+ * Unit for the measure, a pointer using the binding syntax to some field containing the unit. Value of
4393
+ * the given field from the same data record will be displayed after formatted measure value in data label,
4394
+ * tooltip and chart popover. NOTE: To work properly, the unit field must be set as visible dimension in
4395
+ * chart, and only one unit value exists for any visible dimension value combination.
4396
+ */
4397
+ unitBinding?: string | PropertyBindingInfo;
4398
+
4399
+ /**
4400
+ * @deprecated - Please use {@link sap.chart.Chart#setVizProperties} to set related formatStrings instead.
4401
+ *
4402
+ * A (core UI5) format pattern to be used by the formatter to format the measure value.
4403
+ */
4404
+ valueFormat?: string | PropertyBindingInfo;
4405
+
4406
+ /**
4407
+ * How values of Measure will be rendered in the chart. Possible role values are {@link sap.chart.data.MeasureRoleType
4408
+ * axis1}, {@link sap.chart.data.MeasureRoleType axis2}, {@link sap.chart.data.MeasureRoleType axis3}, and
4409
+ * {@link sap.chart.data.MeasureRoleType axis4}. The default is {@link sap.chart.data.MeasureRoleType axis1}.
4410
+ * They correspond to the well-known concepts of axis identifiers in the Cartesian coordinate system, e.g.
4411
+ * a Y-axis in a bar/column/line chart, an X- and a Y-axis in a scatter chart, or two Y-axes in bar charts,
4412
+ * and an optional third axis for the weight/size/intensity/temperature of a data point.
4413
+ *
4414
+ * You can create a new measure as follow:
4415
+ * ```javascript
4416
+ *
4417
+ * ...
4418
+ * new sap.chart.data.Measure({name: "MEASURE1", role: sap.chart.data.MeasureRoleType.axis1})
4419
+ * ...
4420
+ * ```
4421
+ *
4422
+ *
4423
+ * Detailed usage of measure role. Please refer to {@link sap.chart.data.MeasureRoleType MeasureRoleType}
4424
+ *
4425
+ * **NOTE:** Role definition would not work for Bullet Chart and users need to set semantics instead.
4426
+ */
4427
+ role?: string | PropertyBindingInfo;
4428
+
4429
+ /**
4430
+ * The semantics of the measure.
4431
+ *
4432
+ * **NOTE:** Dimension-based coloring (see {@link sap.chart.Chart#setColorings}) does not work when semantics
4433
+ * is set to {@link sap.chart.data.MeasureSemantics.Projected} or {@link sap.chart.data.MeasureSemantics.Reference}
4434
+ * for visible measure(s).
4435
+ *
4436
+ * **NOTE:** In Bullet chart measure defined as "Reference" maps to targetValues and "Projected" maps to
4437
+ * additionalValues. Measures without definition will be recognized as actualValues.
4438
+ */
4439
+ semantics?: MeasureSemantics | PropertyBindingInfo | `{${string}}`;
4440
+
4441
+ /**
4442
+ * Semantically related measures for a measure with semantics "actual" value. It is an object with two properties:
4443
+ *
4444
+ * - "projectedValueMeasure" identifing the projected value measure, and
4445
+ * - "referenceValueMeasure" identifing the reference value measure.
4446
+ */
4447
+ semanticallyRelatedMeasures?: object | PropertyBindingInfo | `{${string}}`;
4448
+
4449
+ /**
4450
+ * @SINCE 1.63
4451
+ * @EXPERIMENTAL
4452
+ *
4453
+ * The analytical extra information
4454
+ */
4455
+ analyticalInfo?: object | PropertyBindingInfo | `{${string}}`;
4456
+ }
4457
+ }
4458
+
4459
+ declare module "sap/chart/data/MeasureRoleType" {
4460
+ /**
4461
+ * Enum of supported role types for Measure
4462
+ */
4463
+ enum MeasureRoleType {
4464
+ /**
4465
+ * General Rules for all chart types
4466
+ * - All measues with role "axis1" are assigned to feed uid "valueaxis". All measures with role "axis2"
4467
+ * are assigned to feed uid "valueaxis2". All measures with role "axis3" are assigned to feed uid "bubbleWidth".
4468
+ *
4469
+ * - If a chart type does not use the feed uid "valueaxis2", then all measures with role "axis2" are treated
4470
+ * as measures with role "axis1".
4471
+ * - If a chart type requires at least 1 measure on the feed uid "valueaxis" (true for all non-"dual"
4472
+ * chart types), but there is no measure with role "axis1", then the first measure with role "axis2" is
4473
+ * assigned to feed uid "valueaxis"
4474
+ * - If the chart type requires at least one measure on the feed uid "valueaxis2" (true for all "dual"
4475
+ * chart types"), but there is no measure with role "axis2", then the first measure with role "axis3" or
4476
+ * "axis4" or (if not exists) the last measure with role "axis1" is assigned to feed uid "valueaxis2".
4477
+ */
4478
+ axis1 = "axis1",
4479
+ /**
4480
+ * Measures with role "axis2" are assigned to feed uid "valueaxis2" if used. If a chart type does not use
4481
+ * the feed uid "bubbleWidth" (true for all chart types except bubble and radar), then all measures with
4482
+ * role "axis3" or "axis4" are treated as measures with role "axis2".
4483
+ */
4484
+ axis2 = "axis2",
4485
+ /**
4486
+ * Measures with role "axis3" are assigned to feed uid "bubbleWidth" if used.
4487
+ */
4488
+ axis3 = "axis3",
4489
+ /**
4490
+ * @deprecated - Please use other MeasureRoleType for specific usage.
4491
+ *
4492
+ * Once used by Bullet Chart, but as this chart layout is configured via semantic patterns instead, "Asix4"
4493
+ * has no special usage from now on.
4494
+ */
4495
+ axis4 = "axis4",
4496
+ }
4497
+ export default MeasureRoleType;
4498
+ }
4499
+
4500
+ declare module "sap/chart/data/MeasureSemantics" {
4501
+ /**
4502
+ * Enum of available semantics value for Measure.
4503
+ */
4504
+ enum MeasureSemantics {
4505
+ /**
4506
+ * facts that happened in the past.
4507
+ */
4508
+ Actual = "actual",
4509
+ /**
4510
+ * where values should be, e.g.: thresholds, targets.
4511
+ */
4512
+ Projected = "projected",
4513
+ /**
4514
+ * where values will be, e.g.: forecasts, estimations, predictions.
4515
+ */
4516
+ Reference = "reference",
4517
+ }
4518
+ export default MeasureSemantics;
4519
+ }
4520
+
4521
+ declare module "sap/chart/data/TimeDimension" {
4522
+ import {
4523
+ default as Dimension,
4524
+ $DimensionSettings,
4525
+ } from "sap/chart/data/Dimension";
4526
+
4527
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
4528
+
4529
+ import TimeUnitType from "sap/chart/TimeUnitType";
4530
+
4531
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
4532
+
4533
+ /**
4534
+ * @SINCE 1.38.0
4535
+ *
4536
+ * Definition of a single time dimension in a chart
4537
+ *
4538
+ * If there is exactly one dimension with time semantics, then instead of line, time_line shall be used
4539
+ * (implicitly).
4540
+ *
4541
+ * TimeDmension is assigned to feed uid "timeAxis".
4542
+ */
4543
+ export default class TimeDimension extends Dimension {
4544
+ /**
4545
+ * Constructor for a new ui5/data/TimeDimension.
4546
+ *
4547
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
4548
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
4549
+ * of the syntax of the settings object.
4550
+ */
4551
+ constructor(
4552
+ /**
4553
+ * initial settings for the new control
4554
+ */
4555
+ mSettings?: $TimeDimensionSettings
4556
+ );
4557
+ /**
4558
+ * Constructor for a new ui5/data/TimeDimension.
4559
+ *
4560
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
4561
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
4562
+ * of the syntax of the settings object.
4563
+ */
4564
+ constructor(
4565
+ /**
4566
+ * id for the new control, generated automatically if no id is given
4567
+ */
4568
+ sId?: string,
4569
+ /**
4570
+ * initial settings for the new control
4571
+ */
4572
+ mSettings?: $TimeDimensionSettings
4573
+ );
4574
+
4575
+ /**
4576
+ * Creates a new subclass of class sap.chart.data.TimeDimension with name `sClassName` and enriches it with
4577
+ * the information contained in `oClassInfo`.
4578
+ *
4579
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.chart.data.Dimension.extend}.
4580
+ *
4581
+ * @returns Created class / constructor function
4582
+ */
4583
+ static extend<T extends Record<string, unknown>>(
4584
+ /**
4585
+ * Name of the class being created
4586
+ */
4587
+ sClassName: string,
4588
+ /**
4589
+ * Object literal with information about the class
4590
+ */
4591
+ oClassInfo?: sap.ClassInfo<T, TimeDimension>,
4592
+ /**
4593
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
4594
+ * used by this class
4595
+ */
4596
+ FNMetaImpl?: Function
4597
+ ): Function;
4598
+ /**
4599
+ * Returns a metadata object for class sap.chart.data.TimeDimension.
4600
+ *
4601
+ * @returns Metadata object describing this class
4602
+ */
4603
+ static getMetadata(): ElementMetadata;
4604
+ /**
4605
+ * Gets current value of property {@link #getFiscalYearPeriodCount fiscalYearPeriodCount}.
4606
+ *
4607
+ * Detailed fiscalYearPeriodCount of TimeDimension. It contains period numbers of fiscal years, like
4608
+ * ```javascript
4609
+ *
4610
+ * {
4611
+ * default: 12,
4612
+ * deviations: {
4613
+ * "2012": 10,
4614
+ * "2013": 16
4615
+ * }
4616
+ * }
4617
+ * ```
4618
+ *
4619
+ *
4620
+ * @returns Value of property `fiscalYearPeriodCount`
4621
+ */
4622
+ getFiscalYearPeriodCount(): object;
4623
+ /**
4624
+ * Gets current value of property {@link #getProjectedValueStartTime projectedValueStartTime}.
4625
+ *
4626
+ * A time value (aligned with 'timeUnit') to indicate the start point of projected values.
4627
+ *
4628
+ * @returns Value of property `projectedValueStartTime`
4629
+ */
4630
+ getProjectedValueStartTime(): any;
4631
+ /**
4632
+ * Gets current value of property {@link #getTimeUnit timeUnit}.
4633
+ *
4634
+ * Detailed unit infomation of TimeDimension. Please refer to {@link sap.chart.TimeUnitType TimeUnitType}.
4635
+ *
4636
+ * @returns Value of property `timeUnit`
4637
+ */
4638
+ getTimeUnit(): TimeUnitType | keyof typeof TimeUnitType;
4639
+ /**
4640
+ * Sets a new value for property {@link #getFiscalYearPeriodCount fiscalYearPeriodCount}.
4641
+ *
4642
+ * Detailed fiscalYearPeriodCount of TimeDimension. It contains period numbers of fiscal years, like
4643
+ * ```javascript
4644
+ *
4645
+ * {
4646
+ * default: 12,
4647
+ * deviations: {
4648
+ * "2012": 10,
4649
+ * "2013": 16
4650
+ * }
4651
+ * }
4652
+ * ```
4653
+ *
4654
+ *
4655
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4656
+ *
4657
+ * @returns Reference to `this` in order to allow method chaining
4658
+ */
4659
+ setFiscalYearPeriodCount(
4660
+ /**
4661
+ * New value for property `fiscalYearPeriodCount`
4662
+ */
4663
+ oFiscalYearPeriodCount: object
4664
+ ): this;
4665
+ /**
4666
+ * Sets a new value for property {@link #getProjectedValueStartTime projectedValueStartTime}.
4667
+ *
4668
+ * A time value (aligned with 'timeUnit') to indicate the start point of projected values.
4669
+ *
4670
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4671
+ *
4672
+ * @returns Reference to `this` in order to allow method chaining
4673
+ */
4674
+ setProjectedValueStartTime(
4675
+ /**
4676
+ * New value for property `projectedValueStartTime`
4677
+ */
4678
+ oProjectedValueStartTime: any
4679
+ ): this;
4680
+ /**
4681
+ * Sets a new value for property {@link #getTimeUnit timeUnit}.
4682
+ *
4683
+ * Detailed unit infomation of TimeDimension. Please refer to {@link sap.chart.TimeUnitType TimeUnitType}.
4684
+ *
4685
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4686
+ *
4687
+ * @returns Reference to `this` in order to allow method chaining
4688
+ */
4689
+ setTimeUnit(
4690
+ /**
4691
+ * New value for property `timeUnit`
4692
+ */
4693
+ sTimeUnit: TimeUnitType | keyof typeof TimeUnitType
4694
+ ): this;
4695
+ }
4696
+
4697
+ export interface $TimeDimensionSettings extends $DimensionSettings {
4698
+ /**
4699
+ * Detailed unit infomation of TimeDimension. Please refer to {@link sap.chart.TimeUnitType TimeUnitType}.
4700
+ */
4701
+ timeUnit?:
4702
+ | (TimeUnitType | keyof typeof TimeUnitType)
4703
+ | PropertyBindingInfo
4704
+ | `{${string}}`;
4705
+
4706
+ /**
4707
+ * Detailed fiscalYearPeriodCount of TimeDimension. It contains period numbers of fiscal years, like
4708
+ * ```javascript
4709
+ *
4710
+ * {
4711
+ * default: 12,
4712
+ * deviations: {
4713
+ * "2012": 10,
4714
+ * "2013": 16
4715
+ * }
4716
+ * }
4717
+ * ```
4718
+ */
4719
+ fiscalYearPeriodCount?: object | PropertyBindingInfo | `{${string}}`;
4720
+
4721
+ /**
4722
+ * A time value (aligned with 'timeUnit') to indicate the start point of projected values.
4723
+ */
4724
+ projectedValueStartTime?: any | PropertyBindingInfo | `{${string}}`;
4725
+ }
4726
+ }
4727
+
4728
+ declare module "sap/chart/ScaleBehavior" {
4729
+ /**
4730
+ * Enumeration for the value axes scale behavior of analytical chart.
4731
+ */
4732
+ enum ScaleBehavior {
4733
+ /**
4734
+ * Value axes scale is automatic.
4735
+ */
4736
+ AutoScale = "AutoScale",
4737
+ /**
4738
+ * Value axes scale is fixed.
4739
+ */
4740
+ FixedScale = "FixedScale",
4741
+ }
4742
+ export default ScaleBehavior;
4743
+ }
4744
+
4745
+ declare module "sap/chart/TimeUnitType" {
4746
+ /**
4747
+ * Enumeration for supported time unit types in analytical chart
4748
+ */
4749
+ enum TimeUnitType {
4750
+ /**
4751
+ * type is Edm.DateTime and V2 annotation sap:display-format is "Date" or timestamp, and type is Edm.Date
4752
+ * in V4
4753
+ */
4754
+ Date = "Date",
4755
+ /**
4756
+ * type is Edm.string, like "YYYY"
4757
+ */
4758
+ fiscalyear = "fiscalyear",
4759
+ /**
4760
+ * type is Edm.string, like "YYYYPPP"
4761
+ */
4762
+ fiscalyearperiod = "fiscalyearperiod",
4763
+ /**
4764
+ * type is Edm.string, like "yyyyMM"
4765
+ */
4766
+ yearmonth = "yearmonth",
4767
+ /**
4768
+ * type is Edm.string and V2 annotation sap:semantics is "yearmonthday", like "yyyyMMdd"
4769
+ */
4770
+ yearmonthday = "yearmonthday",
4771
+ /**
4772
+ * type is Edm.string, like "yyyyQQQQQ"
4773
+ */
4774
+ yearquarter = "yearquarter",
4775
+ /**
4776
+ * type is Edm.string, like "yyyyww"
4777
+ */
4778
+ yearweek = "yearweek",
4779
+ }
4780
+ export default TimeUnitType;
4781
+ }
4782
+
4783
+ declare namespace sap {
4784
+ interface IUI5DefineDependencyNames {
4785
+ "sap/chart/AutoScaleMode": undefined;
4786
+
4787
+ "sap/chart/Chart": undefined;
4788
+
4789
+ "sap/chart/ChartType": undefined;
4790
+
4791
+ "sap/chart/coloring/CriticalityType": undefined;
4792
+
4793
+ "sap/chart/ColoringType": undefined;
4794
+
4795
+ "sap/chart/data/Dimension": undefined;
4796
+
4797
+ "sap/chart/data/DimensionRoleType": undefined;
4798
+
4799
+ "sap/chart/data/HierarchyDimension": undefined;
4800
+
4801
+ "sap/chart/data/Measure": undefined;
4802
+
4803
+ "sap/chart/data/MeasureRoleType": undefined;
4804
+
4805
+ "sap/chart/data/MeasureSemantics": undefined;
4806
+
4807
+ "sap/chart/data/TimeDimension": undefined;
4808
+
4809
+ "sap/chart/library": undefined;
4810
+
4811
+ "sap/chart/ScaleBehavior": undefined;
4812
+
4813
+ "sap/chart/TimeUnitType": undefined;
4814
+ }
4815
+ }