@sapui5/ts-types 1.101.1 → 1.102.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/index.d.ts +1 -0
- package/types/sap.apf.d.ts +89 -1
- package/types/sap.ca.ui.d.ts +1747 -124
- package/types/sap.chart.d.ts +375 -29
- package/types/sap.collaboration.d.ts +320 -40
- package/types/sap.esh.search.ui.d.ts +1 -669
- package/types/sap.f.d.ts +1785 -100
- package/types/sap.fe.common.d.ts +1 -1
- package/types/sap.fe.core.d.ts +70 -2
- package/types/sap.fe.macros.d.ts +78 -34
- package/types/sap.fe.navigation.d.ts +144 -4
- package/types/sap.fe.templates.d.ts +26 -5
- package/types/sap.fe.test.d.ts +497 -2
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +7203 -502
- package/types/sap.insights.d.ts +80 -0
- package/types/sap.landvisz.d.ts +1015 -66
- package/types/sap.m.d.ts +16491 -1149
- package/types/sap.makit.d.ts +575 -54
- package/types/sap.me.d.ts +578 -51
- package/types/sap.ndc.d.ts +63 -5
- package/types/sap.ovp.d.ts +5 -6
- package/types/sap.rules.ui.d.ts +171 -15
- package/types/sap.sac.df.d.ts +1430 -215
- package/types/sap.sac.grid.d.ts +91 -8
- package/types/sap.suite.ui.commons.d.ts +5515 -396
- package/types/sap.suite.ui.generic.template.d.ts +157 -69
- package/types/sap.suite.ui.microchart.d.ts +1801 -160
- package/types/sap.tnt.d.ts +279 -19
- package/types/sap.ui.codeeditor.d.ts +89 -8
- package/types/sap.ui.commons.d.ts +3784 -313
- package/types/sap.ui.comp.d.ts +3853 -276
- package/types/sap.ui.core.d.ts +6248 -313
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +61 -6
- package/types/sap.ui.fl.d.ts +1 -1
- package/types/sap.ui.generic.app.d.ts +238 -64
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +316 -23
- package/types/sap.ui.layout.d.ts +1851 -199
- package/types/sap.ui.mdc.d.ts +1 -1
- package/types/sap.ui.richtexteditor.d.ts +340 -49
- package/types/sap.ui.rta.d.ts +5 -1
- package/types/sap.ui.suite.d.ts +87 -6
- package/types/sap.ui.support.d.ts +30 -1
- package/types/sap.ui.table.d.ts +1050 -80
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +2704 -202
- package/types/sap.ui.ux3.d.ts +2379 -181
- package/types/sap.ui.vbm.d.ts +2002 -197
- package/types/sap.ui.vk.d.ts +5353 -310
- package/types/sap.ui.vtm.d.ts +1130 -41
- package/types/sap.uiext.inbox.d.ts +423 -22
- package/types/sap.ushell.d.ts +1488 -49
- package/types/sap.ushell_abap.d.ts +4 -1
- package/types/sap.uxap.d.ts +902 -87
- package/types/sap.viz.d.ts +5514 -380
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +165 -20
- package/types/sap.zen.crosstab.d.ts +217 -21
- package/types/sap.zen.dsh.d.ts +227 -14
package/types/sap.chart.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.102.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
/**
|
|
@@ -11,6 +11,16 @@ declare namespace sap {
|
|
|
11
11
|
namespace api {
|
|
12
12
|
/**
|
|
13
13
|
* Get the Dimensions and Measures layout for a certain ChartType with provided Dimensions and Measures.
|
|
14
|
+
*
|
|
15
|
+
* @returns the chart layout object of the following form:
|
|
16
|
+
* ```javascript
|
|
17
|
+
*
|
|
18
|
+
* {
|
|
19
|
+
* dimensions: [], // names of dimensions that will be rendered
|
|
20
|
+
* measures: [], // names of measures that will be rendered
|
|
21
|
+
* errors: [], // reasons of why the chart cannot be rendered with the given (chartType, dimensions, measures) combination
|
|
22
|
+
* }
|
|
23
|
+
* ```
|
|
14
24
|
*/
|
|
15
25
|
function getChartTypeLayout(
|
|
16
26
|
/**
|
|
@@ -28,6 +38,8 @@ declare namespace sap {
|
|
|
28
38
|
): object;
|
|
29
39
|
/**
|
|
30
40
|
* Returns all chart types currently supported by chart control (subset of viz types).
|
|
41
|
+
*
|
|
42
|
+
* @returns a map with chartType as key, localized chart name as value.
|
|
31
43
|
*/
|
|
32
44
|
function getChartTypes(): object;
|
|
33
45
|
}
|
|
@@ -191,7 +203,8 @@ declare namespace sap {
|
|
|
191
203
|
*/
|
|
192
204
|
textFormatter?:
|
|
193
205
|
| Function
|
|
194
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
206
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
207
|
+
| `{${string}}`;
|
|
195
208
|
|
|
196
209
|
/**
|
|
197
210
|
* Text for a Dimension key value, typically by a pointer using the binding syntax to some property containing
|
|
@@ -206,7 +219,10 @@ declare namespace sap {
|
|
|
206
219
|
* Whether a text is displayed. If the "textProperty" property has not been specified, it will be derived
|
|
207
220
|
* from the metadata.
|
|
208
221
|
*/
|
|
209
|
-
displayText?:
|
|
222
|
+
displayText?:
|
|
223
|
+
| boolean
|
|
224
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
225
|
+
| `{${string}}`;
|
|
210
226
|
|
|
211
227
|
/**
|
|
212
228
|
* How the Dimension will influence the chart layout. Possible values are {@link sap.chart.data.DimensionRoleType
|
|
@@ -236,7 +252,10 @@ declare namespace sap {
|
|
|
236
252
|
* of drill stack. Getter of this property just returns level explicitly set by user, call {@link sap.chart.Chart#getDrillStack}
|
|
237
253
|
* and refer to 'hierarchylevel' if you need current level after drilling
|
|
238
254
|
*/
|
|
239
|
-
level?:
|
|
255
|
+
level?:
|
|
256
|
+
| int
|
|
257
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
258
|
+
| `{${string}}`;
|
|
240
259
|
}
|
|
241
260
|
|
|
242
261
|
interface $MeasureSettings extends sap.ui.core.$ElementSettings {
|
|
@@ -301,7 +320,8 @@ declare namespace sap {
|
|
|
301
320
|
*/
|
|
302
321
|
semantics?:
|
|
303
322
|
| sap.chart.data.MeasureSemantics
|
|
304
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
323
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
324
|
+
| `{${string}}`;
|
|
305
325
|
|
|
306
326
|
/**
|
|
307
327
|
* Semantically related measures for a measure with semantics "actual" value. It is an object with two properties:
|
|
@@ -311,7 +331,8 @@ declare namespace sap {
|
|
|
311
331
|
*/
|
|
312
332
|
semanticallyRelatedMeasures?:
|
|
313
333
|
| object
|
|
314
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
334
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
335
|
+
| `{${string}}`;
|
|
315
336
|
|
|
316
337
|
/**
|
|
317
338
|
* @SINCE 1.63
|
|
@@ -319,7 +340,10 @@ declare namespace sap {
|
|
|
319
340
|
*
|
|
320
341
|
* The analytical extra information
|
|
321
342
|
*/
|
|
322
|
-
analyticalInfo?:
|
|
343
|
+
analyticalInfo?:
|
|
344
|
+
| object
|
|
345
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
346
|
+
| `{${string}}`;
|
|
323
347
|
}
|
|
324
348
|
|
|
325
349
|
interface $TimeDimensionSettings
|
|
@@ -329,7 +353,8 @@ declare namespace sap {
|
|
|
329
353
|
*/
|
|
330
354
|
timeUnit?:
|
|
331
355
|
| sap.chart.TimeUnitType
|
|
332
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
356
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
357
|
+
| `{${string}}`;
|
|
333
358
|
|
|
334
359
|
/**
|
|
335
360
|
* Detailed fiscalYearPeriodCount of TimeDimension. It contains period numbers of fiscal years, like
|
|
@@ -346,14 +371,16 @@ declare namespace sap {
|
|
|
346
371
|
*/
|
|
347
372
|
fiscalYearPeriodCount?:
|
|
348
373
|
| object
|
|
349
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
374
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
375
|
+
| `{${string}}`;
|
|
350
376
|
|
|
351
377
|
/**
|
|
352
378
|
* A time value (aligned with 'timeUnit') to indicate the start point of projected values.
|
|
353
379
|
*/
|
|
354
380
|
projectedValueStartTime?:
|
|
355
381
|
| any
|
|
356
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
382
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
383
|
+
| `{${string}}`;
|
|
357
384
|
}
|
|
358
385
|
|
|
359
386
|
/**
|
|
@@ -404,6 +431,8 @@ declare namespace sap {
|
|
|
404
431
|
* the information contained in `oClassInfo`.
|
|
405
432
|
*
|
|
406
433
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
434
|
+
*
|
|
435
|
+
* @returns Created class / constructor function
|
|
407
436
|
*/
|
|
408
437
|
static extend<T extends Record<string, unknown>>(
|
|
409
438
|
/**
|
|
@@ -422,6 +451,8 @@ declare namespace sap {
|
|
|
422
451
|
): Function;
|
|
423
452
|
/**
|
|
424
453
|
* Returns a metadata object for class sap.chart.data.Dimension.
|
|
454
|
+
*
|
|
455
|
+
* @returns Metadata object describing this class
|
|
425
456
|
*/
|
|
426
457
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
427
458
|
/**
|
|
@@ -431,6 +462,8 @@ declare namespace sap {
|
|
|
431
462
|
* from the metadata.
|
|
432
463
|
*
|
|
433
464
|
* Default value is `true`.
|
|
465
|
+
*
|
|
466
|
+
* @returns Value of property `displayText`
|
|
434
467
|
*/
|
|
435
468
|
getDisplayText(): boolean;
|
|
436
469
|
/**
|
|
@@ -441,12 +474,16 @@ declare namespace sap {
|
|
|
441
474
|
*
|
|
442
475
|
* **NOTE:** This property was bound internally if automatically created via metadata of oData service and
|
|
443
476
|
* please call "unbindProperty" before setting.
|
|
477
|
+
*
|
|
478
|
+
* @returns Value of property `label`
|
|
444
479
|
*/
|
|
445
480
|
getLabel(): string;
|
|
446
481
|
/**
|
|
447
482
|
* Gets current value of property {@link #getName name}.
|
|
448
483
|
*
|
|
449
484
|
* Property in the "data" model holding the (always unique) Dimension key.
|
|
485
|
+
*
|
|
486
|
+
* @returns Value of property `name`
|
|
450
487
|
*/
|
|
451
488
|
getName(): string;
|
|
452
489
|
/**
|
|
@@ -470,6 +507,8 @@ declare namespace sap {
|
|
|
470
507
|
* **NOTE:** Has no effect if the Dimension is used as inResultDimensions by Chart
|
|
471
508
|
*
|
|
472
509
|
* Default value is `"category"`.
|
|
510
|
+
*
|
|
511
|
+
* @returns Value of property `role`
|
|
473
512
|
*/
|
|
474
513
|
getRole(): string;
|
|
475
514
|
/**
|
|
@@ -478,6 +517,8 @@ declare namespace sap {
|
|
|
478
517
|
* Function returning a formatted text for a Dimension key value that will be used for axis labelling. If
|
|
479
518
|
* specified, this property takes precedence over the "textProperty" property of the Dimension. Dimension
|
|
480
519
|
* key value and the corresponding text will be passed to the supplied function as parameters.
|
|
520
|
+
*
|
|
521
|
+
* @returns Value of property `textFormatter`
|
|
481
522
|
*/
|
|
482
523
|
getTextFormatter(): Function;
|
|
483
524
|
/**
|
|
@@ -488,6 +529,8 @@ declare namespace sap {
|
|
|
488
529
|
*
|
|
489
530
|
* **NOTE:** This property was bound internally if automatically created via metadata of oData service and
|
|
490
531
|
* please call "unbindProperty" before setting.
|
|
532
|
+
*
|
|
533
|
+
* @returns Value of property `textProperty`
|
|
491
534
|
*/
|
|
492
535
|
getTextProperty(): string;
|
|
493
536
|
/**
|
|
@@ -499,6 +542,8 @@ declare namespace sap {
|
|
|
499
542
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
500
543
|
*
|
|
501
544
|
* Default value is `true`.
|
|
545
|
+
*
|
|
546
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
502
547
|
*/
|
|
503
548
|
setDisplayText(
|
|
504
549
|
/**
|
|
@@ -516,6 +561,8 @@ declare namespace sap {
|
|
|
516
561
|
* please call "unbindProperty" before setting.
|
|
517
562
|
*
|
|
518
563
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
564
|
+
*
|
|
565
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
519
566
|
*/
|
|
520
567
|
setLabel(
|
|
521
568
|
/**
|
|
@@ -529,6 +576,8 @@ declare namespace sap {
|
|
|
529
576
|
* Property in the "data" model holding the (always unique) Dimension key.
|
|
530
577
|
*
|
|
531
578
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
579
|
+
*
|
|
580
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
532
581
|
*/
|
|
533
582
|
setName(
|
|
534
583
|
/**
|
|
@@ -559,6 +608,8 @@ declare namespace sap {
|
|
|
559
608
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
560
609
|
*
|
|
561
610
|
* Default value is `"category"`.
|
|
611
|
+
*
|
|
612
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
562
613
|
*/
|
|
563
614
|
setRole(
|
|
564
615
|
/**
|
|
@@ -574,6 +625,8 @@ declare namespace sap {
|
|
|
574
625
|
* key value and the corresponding text will be passed to the supplied function as parameters.
|
|
575
626
|
*
|
|
576
627
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
628
|
+
*
|
|
629
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
577
630
|
*/
|
|
578
631
|
setTextFormatter(
|
|
579
632
|
/**
|
|
@@ -591,6 +644,8 @@ declare namespace sap {
|
|
|
591
644
|
* please call "unbindProperty" before setting.
|
|
592
645
|
*
|
|
593
646
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
647
|
+
*
|
|
648
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
594
649
|
*/
|
|
595
650
|
setTextProperty(
|
|
596
651
|
/**
|
|
@@ -641,6 +696,8 @@ declare namespace sap {
|
|
|
641
696
|
* it with the information contained in `oClassInfo`.
|
|
642
697
|
*
|
|
643
698
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.chart.data.Dimension.extend}.
|
|
699
|
+
*
|
|
700
|
+
* @returns Created class / constructor function
|
|
644
701
|
*/
|
|
645
702
|
static extend<T extends Record<string, unknown>>(
|
|
646
703
|
/**
|
|
@@ -659,6 +716,8 @@ declare namespace sap {
|
|
|
659
716
|
): Function;
|
|
660
717
|
/**
|
|
661
718
|
* Returns a metadata object for class sap.chart.data.HierarchyDimension.
|
|
719
|
+
*
|
|
720
|
+
* @returns Metadata object describing this class
|
|
662
721
|
*/
|
|
663
722
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
664
723
|
/**
|
|
@@ -669,6 +728,8 @@ declare namespace sap {
|
|
|
669
728
|
* and refer to 'hierarchylevel' if you need current level after drilling
|
|
670
729
|
*
|
|
671
730
|
* Default value is `0`.
|
|
731
|
+
*
|
|
732
|
+
* @returns Value of property `level`
|
|
672
733
|
*/
|
|
673
734
|
getLevel(): int;
|
|
674
735
|
/**
|
|
@@ -681,6 +742,8 @@ declare namespace sap {
|
|
|
681
742
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
682
743
|
*
|
|
683
744
|
* Default value is `0`.
|
|
745
|
+
*
|
|
746
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
684
747
|
*/
|
|
685
748
|
setLevel(
|
|
686
749
|
/**
|
|
@@ -746,6 +809,8 @@ declare namespace sap {
|
|
|
746
809
|
* information contained in `oClassInfo`.
|
|
747
810
|
*
|
|
748
811
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
812
|
+
*
|
|
813
|
+
* @returns Created class / constructor function
|
|
749
814
|
*/
|
|
750
815
|
static extend<T extends Record<string, unknown>>(
|
|
751
816
|
/**
|
|
@@ -764,6 +829,8 @@ declare namespace sap {
|
|
|
764
829
|
): Function;
|
|
765
830
|
/**
|
|
766
831
|
* Returns a metadata object for class sap.chart.data.Measure.
|
|
832
|
+
*
|
|
833
|
+
* @returns Metadata object describing this class
|
|
767
834
|
*/
|
|
768
835
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
769
836
|
/**
|
|
@@ -773,6 +840,8 @@ declare namespace sap {
|
|
|
773
840
|
* Gets current value of property {@link #getAnalyticalInfo analyticalInfo}.
|
|
774
841
|
*
|
|
775
842
|
* The analytical extra information
|
|
843
|
+
*
|
|
844
|
+
* @returns Value of property `analyticalInfo`
|
|
776
845
|
*/
|
|
777
846
|
getAnalyticalInfo(): object;
|
|
778
847
|
/**
|
|
@@ -780,12 +849,16 @@ declare namespace sap {
|
|
|
780
849
|
*
|
|
781
850
|
* Label for the Measure, either as a string literal or by a pointer using the binding syntax to some property
|
|
782
851
|
* containing the label.
|
|
852
|
+
*
|
|
853
|
+
* @returns Value of property `label`
|
|
783
854
|
*/
|
|
784
855
|
getLabel(): string;
|
|
785
856
|
/**
|
|
786
857
|
* Gets current value of property {@link #getName name}.
|
|
787
858
|
*
|
|
788
859
|
* Property in the "data" model holding the raw measure value.
|
|
860
|
+
*
|
|
861
|
+
* @returns Value of property `name`
|
|
789
862
|
*/
|
|
790
863
|
getName(): string;
|
|
791
864
|
/**
|
|
@@ -812,6 +885,8 @@ declare namespace sap {
|
|
|
812
885
|
* **NOTE:** Role definition would not work for Bullet Chart and users need to set semantics instead.
|
|
813
886
|
*
|
|
814
887
|
* Default value is `"axis1"`.
|
|
888
|
+
*
|
|
889
|
+
* @returns Value of property `role`
|
|
815
890
|
*/
|
|
816
891
|
getRole(): string;
|
|
817
892
|
/**
|
|
@@ -821,6 +896,8 @@ declare namespace sap {
|
|
|
821
896
|
*
|
|
822
897
|
* - "projectedValueMeasure" identifing the projected value measure, and
|
|
823
898
|
* - "referenceValueMeasure" identifing the reference value measure.
|
|
899
|
+
*
|
|
900
|
+
* @returns Value of property `semanticallyRelatedMeasures`
|
|
824
901
|
*/
|
|
825
902
|
getSemanticallyRelatedMeasures(): object;
|
|
826
903
|
/**
|
|
@@ -836,6 +913,8 @@ declare namespace sap {
|
|
|
836
913
|
* additionalValues. Measures without definition will be recognized as actualValues.
|
|
837
914
|
*
|
|
838
915
|
* Default value is `Actual`.
|
|
916
|
+
*
|
|
917
|
+
* @returns Value of property `semantics`
|
|
839
918
|
*/
|
|
840
919
|
getSemantics(): sap.chart.data.MeasureSemantics;
|
|
841
920
|
/**
|
|
@@ -845,6 +924,8 @@ declare namespace sap {
|
|
|
845
924
|
* the given field from the same data record will be displayed after formatted measure value in data label,
|
|
846
925
|
* tooltip and chart popover. NOTE: To work properly, the unit field must be set as visible dimension in
|
|
847
926
|
* chart, and only one unit value exists for any visible dimension value combination.
|
|
927
|
+
*
|
|
928
|
+
* @returns Value of property `unitBinding`
|
|
848
929
|
*/
|
|
849
930
|
getUnitBinding(): string;
|
|
850
931
|
/**
|
|
@@ -853,6 +934,8 @@ declare namespace sap {
|
|
|
853
934
|
* Gets current value of property {@link #getValueFormat valueFormat}.
|
|
854
935
|
*
|
|
855
936
|
* A (core UI5) format pattern to be used by the formatter to format the measure value.
|
|
937
|
+
*
|
|
938
|
+
* @returns Value of property `valueFormat`
|
|
856
939
|
*/
|
|
857
940
|
getValueFormat(): string;
|
|
858
941
|
/**
|
|
@@ -864,6 +947,8 @@ declare namespace sap {
|
|
|
864
947
|
* The analytical extra information
|
|
865
948
|
*
|
|
866
949
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
950
|
+
*
|
|
951
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
867
952
|
*/
|
|
868
953
|
setAnalyticalInfo(
|
|
869
954
|
/**
|
|
@@ -878,6 +963,8 @@ declare namespace sap {
|
|
|
878
963
|
* containing the label.
|
|
879
964
|
*
|
|
880
965
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
966
|
+
*
|
|
967
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
881
968
|
*/
|
|
882
969
|
setLabel(
|
|
883
970
|
/**
|
|
@@ -891,6 +978,8 @@ declare namespace sap {
|
|
|
891
978
|
* Property in the "data" model holding the raw measure value.
|
|
892
979
|
*
|
|
893
980
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
981
|
+
*
|
|
982
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
894
983
|
*/
|
|
895
984
|
setName(
|
|
896
985
|
/**
|
|
@@ -924,6 +1013,8 @@ declare namespace sap {
|
|
|
924
1013
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
925
1014
|
*
|
|
926
1015
|
* Default value is `"axis1"`.
|
|
1016
|
+
*
|
|
1017
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
927
1018
|
*/
|
|
928
1019
|
setRole(
|
|
929
1020
|
/**
|
|
@@ -940,6 +1031,8 @@ declare namespace sap {
|
|
|
940
1031
|
* - "referenceValueMeasure" identifing the reference value measure.
|
|
941
1032
|
*
|
|
942
1033
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1034
|
+
*
|
|
1035
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
943
1036
|
*/
|
|
944
1037
|
setSemanticallyRelatedMeasures(
|
|
945
1038
|
/**
|
|
@@ -962,6 +1055,8 @@ declare namespace sap {
|
|
|
962
1055
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
963
1056
|
*
|
|
964
1057
|
* Default value is `Actual`.
|
|
1058
|
+
*
|
|
1059
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
965
1060
|
*/
|
|
966
1061
|
setSemantics(
|
|
967
1062
|
/**
|
|
@@ -978,6 +1073,8 @@ declare namespace sap {
|
|
|
978
1073
|
* chart, and only one unit value exists for any visible dimension value combination.
|
|
979
1074
|
*
|
|
980
1075
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1076
|
+
*
|
|
1077
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
981
1078
|
*/
|
|
982
1079
|
setUnitBinding(
|
|
983
1080
|
/**
|
|
@@ -993,6 +1090,8 @@ declare namespace sap {
|
|
|
993
1090
|
* A (core UI5) format pattern to be used by the formatter to format the measure value.
|
|
994
1091
|
*
|
|
995
1092
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1093
|
+
*
|
|
1094
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
996
1095
|
*/
|
|
997
1096
|
setValueFormat(
|
|
998
1097
|
/**
|
|
@@ -1048,6 +1147,8 @@ declare namespace sap {
|
|
|
1048
1147
|
* the information contained in `oClassInfo`.
|
|
1049
1148
|
*
|
|
1050
1149
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.chart.data.Dimension.extend}.
|
|
1150
|
+
*
|
|
1151
|
+
* @returns Created class / constructor function
|
|
1051
1152
|
*/
|
|
1052
1153
|
static extend<T extends Record<string, unknown>>(
|
|
1053
1154
|
/**
|
|
@@ -1066,6 +1167,8 @@ declare namespace sap {
|
|
|
1066
1167
|
): Function;
|
|
1067
1168
|
/**
|
|
1068
1169
|
* Returns a metadata object for class sap.chart.data.TimeDimension.
|
|
1170
|
+
*
|
|
1171
|
+
* @returns Metadata object describing this class
|
|
1069
1172
|
*/
|
|
1070
1173
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
1071
1174
|
/**
|
|
@@ -1082,18 +1185,25 @@ declare namespace sap {
|
|
|
1082
1185
|
* }
|
|
1083
1186
|
* }
|
|
1084
1187
|
* ```
|
|
1188
|
+
*
|
|
1189
|
+
*
|
|
1190
|
+
* @returns Value of property `fiscalYearPeriodCount`
|
|
1085
1191
|
*/
|
|
1086
1192
|
getFiscalYearPeriodCount(): object;
|
|
1087
1193
|
/**
|
|
1088
1194
|
* Gets current value of property {@link #getProjectedValueStartTime projectedValueStartTime}.
|
|
1089
1195
|
*
|
|
1090
1196
|
* A time value (aligned with 'timeUnit') to indicate the start point of projected values.
|
|
1197
|
+
*
|
|
1198
|
+
* @returns Value of property `projectedValueStartTime`
|
|
1091
1199
|
*/
|
|
1092
1200
|
getProjectedValueStartTime(): any;
|
|
1093
1201
|
/**
|
|
1094
1202
|
* Gets current value of property {@link #getTimeUnit timeUnit}.
|
|
1095
1203
|
*
|
|
1096
1204
|
* Detailed unit infomation of TimeDimension. Please refer to {@link sap.chart.TimeUnitType TimeUnitType}.
|
|
1205
|
+
*
|
|
1206
|
+
* @returns Value of property `timeUnit`
|
|
1097
1207
|
*/
|
|
1098
1208
|
getTimeUnit(): sap.chart.TimeUnitType;
|
|
1099
1209
|
/**
|
|
@@ -1113,6 +1223,8 @@ declare namespace sap {
|
|
|
1113
1223
|
*
|
|
1114
1224
|
*
|
|
1115
1225
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1226
|
+
*
|
|
1227
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1116
1228
|
*/
|
|
1117
1229
|
setFiscalYearPeriodCount(
|
|
1118
1230
|
/**
|
|
@@ -1126,6 +1238,8 @@ declare namespace sap {
|
|
|
1126
1238
|
* A time value (aligned with 'timeUnit') to indicate the start point of projected values.
|
|
1127
1239
|
*
|
|
1128
1240
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1241
|
+
*
|
|
1242
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1129
1243
|
*/
|
|
1130
1244
|
setProjectedValueStartTime(
|
|
1131
1245
|
/**
|
|
@@ -1139,6 +1253,8 @@ declare namespace sap {
|
|
|
1139
1253
|
* Detailed unit infomation of TimeDimension. Please refer to {@link sap.chart.TimeUnitType TimeUnitType}.
|
|
1140
1254
|
*
|
|
1141
1255
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1256
|
+
*
|
|
1257
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1142
1258
|
*/
|
|
1143
1259
|
setTimeUnit(
|
|
1144
1260
|
/**
|
|
@@ -1236,7 +1352,10 @@ declare namespace sap {
|
|
|
1236
1352
|
* Configuration for initialization to VizControl. This property could only set via settings parameter in
|
|
1237
1353
|
* Constructor.
|
|
1238
1354
|
*/
|
|
1239
|
-
uiConfig?:
|
|
1355
|
+
uiConfig?:
|
|
1356
|
+
| object
|
|
1357
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1358
|
+
| `{${string}}`;
|
|
1240
1359
|
|
|
1241
1360
|
/**
|
|
1242
1361
|
* Names of the Dimensions to be displayed in the Chart, all available dimensions will automatically append
|
|
@@ -1246,7 +1365,8 @@ declare namespace sap {
|
|
|
1246
1365
|
*/
|
|
1247
1366
|
visibleDimensions?:
|
|
1248
1367
|
| string[]
|
|
1249
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1368
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1369
|
+
| `{${string}}`;
|
|
1250
1370
|
|
|
1251
1371
|
/**
|
|
1252
1372
|
* Names of the inResult dimensions.
|
|
@@ -1256,7 +1376,8 @@ declare namespace sap {
|
|
|
1256
1376
|
*/
|
|
1257
1377
|
inResultDimensions?:
|
|
1258
1378
|
| string[]
|
|
1259
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1379
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1380
|
+
| `{${string}}`;
|
|
1260
1381
|
|
|
1261
1382
|
/**
|
|
1262
1383
|
* Names of the Measures to be displayed in the Chart.
|
|
@@ -1265,38 +1386,50 @@ declare namespace sap {
|
|
|
1265
1386
|
*/
|
|
1266
1387
|
visibleMeasures?:
|
|
1267
1388
|
| string[]
|
|
1268
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1389
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1390
|
+
| `{${string}}`;
|
|
1269
1391
|
|
|
1270
1392
|
/**
|
|
1271
1393
|
* Chart properties, refer to chart property documentation
|
|
1272
1394
|
* for more details.
|
|
1273
1395
|
*/
|
|
1274
|
-
vizProperties?:
|
|
1396
|
+
vizProperties?:
|
|
1397
|
+
| object
|
|
1398
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1399
|
+
| `{${string}}`;
|
|
1275
1400
|
|
|
1276
1401
|
/**
|
|
1277
1402
|
* /** Chart scales, refer to chart property documentation
|
|
1278
1403
|
* for more details.
|
|
1279
1404
|
*/
|
|
1280
|
-
vizScales?:
|
|
1405
|
+
vizScales?:
|
|
1406
|
+
| object[]
|
|
1407
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1408
|
+
| `{${string}}`;
|
|
1281
1409
|
|
|
1282
1410
|
/**
|
|
1283
1411
|
* Whether or not an aggregated entity set is bound to the chart.
|
|
1284
1412
|
*/
|
|
1285
|
-
isAnalytical?:
|
|
1413
|
+
isAnalytical?:
|
|
1414
|
+
| boolean
|
|
1415
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1416
|
+
| `{${string}}`;
|
|
1286
1417
|
|
|
1287
1418
|
/**
|
|
1288
1419
|
* Chart selection behavior.
|
|
1289
1420
|
*/
|
|
1290
1421
|
selectionBehavior?:
|
|
1291
1422
|
| sap.chart.SelectionBehavior
|
|
1292
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1423
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1424
|
+
| `{${string}}`;
|
|
1293
1425
|
|
|
1294
1426
|
/**
|
|
1295
1427
|
* Chart selection mode.
|
|
1296
1428
|
*/
|
|
1297
1429
|
selectionMode?:
|
|
1298
1430
|
| sap.chart.SelectionMode
|
|
1299
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1431
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1432
|
+
| `{${string}}`;
|
|
1300
1433
|
|
|
1301
1434
|
/**
|
|
1302
1435
|
* Enable pagination mode.
|
|
@@ -1314,26 +1447,32 @@ declare namespace sap {
|
|
|
1314
1447
|
*/
|
|
1315
1448
|
enablePagination?:
|
|
1316
1449
|
| boolean
|
|
1317
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1450
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1451
|
+
| `{${string}}`;
|
|
1318
1452
|
|
|
1319
1453
|
/**
|
|
1320
1454
|
* Enable Stable color mode. To keep the same colors for the same dimension values or measure names.
|
|
1321
1455
|
*/
|
|
1322
1456
|
enableStableColor?:
|
|
1323
1457
|
| boolean
|
|
1324
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1458
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1459
|
+
| `{${string}}`;
|
|
1325
1460
|
|
|
1326
1461
|
/**
|
|
1327
1462
|
* Enable scaling factor.
|
|
1328
1463
|
*/
|
|
1329
1464
|
enableScalingFactor?:
|
|
1330
1465
|
| boolean
|
|
1331
|
-
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1466
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1467
|
+
| `{${string}}`;
|
|
1332
1468
|
|
|
1333
1469
|
/**
|
|
1334
1470
|
* Chart custom messages.
|
|
1335
1471
|
*/
|
|
1336
|
-
customMessages?:
|
|
1472
|
+
customMessages?:
|
|
1473
|
+
| object
|
|
1474
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1475
|
+
| `{${string}}`;
|
|
1337
1476
|
|
|
1338
1477
|
/**
|
|
1339
1478
|
* Chart colorings.
|
|
@@ -1362,7 +1501,10 @@ declare namespace sap {
|
|
|
1362
1501
|
* {@link sap.chart.ColoringType.Emphasis}
|
|
1363
1502
|
* for detailed usage
|
|
1364
1503
|
*/
|
|
1365
|
-
colorings?:
|
|
1504
|
+
colorings?:
|
|
1505
|
+
| object
|
|
1506
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1507
|
+
| `{${string}}`;
|
|
1366
1508
|
|
|
1367
1509
|
/**
|
|
1368
1510
|
* Active coloring configurations.
|
|
@@ -1396,7 +1538,10 @@ declare namespace sap {
|
|
|
1396
1538
|
* }
|
|
1397
1539
|
* ```
|
|
1398
1540
|
*/
|
|
1399
|
-
activeColoring?:
|
|
1541
|
+
activeColoring?:
|
|
1542
|
+
| object
|
|
1543
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1544
|
+
| `{${string}}`;
|
|
1400
1545
|
|
|
1401
1546
|
/**
|
|
1402
1547
|
* Value Axis Scale.
|
|
@@ -1473,7 +1618,10 @@ declare namespace sap {
|
|
|
1473
1618
|
* {@link sap.chart.ScaleBehavior.FixedScale}
|
|
1474
1619
|
* for detailed usage
|
|
1475
1620
|
*/
|
|
1476
|
-
valueAxisScale?:
|
|
1621
|
+
valueAxisScale?:
|
|
1622
|
+
| object
|
|
1623
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
1624
|
+
| `{${string}}`;
|
|
1477
1625
|
|
|
1478
1626
|
/**
|
|
1479
1627
|
* Actual data. It can be bound to an (analytical) ODataModel.
|
|
@@ -1484,7 +1632,8 @@ declare namespace sap {
|
|
|
1484
1632
|
data?:
|
|
1485
1633
|
| sap.ui.core.Element[]
|
|
1486
1634
|
| sap.ui.core.Element
|
|
1487
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
1635
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
1636
|
+
| `{${string}}`;
|
|
1488
1637
|
|
|
1489
1638
|
/**
|
|
1490
1639
|
* Dimensions of the data.
|
|
@@ -1492,7 +1641,8 @@ declare namespace sap {
|
|
|
1492
1641
|
dimensions?:
|
|
1493
1642
|
| sap.chart.data.Dimension[]
|
|
1494
1643
|
| sap.chart.data.Dimension
|
|
1495
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
1644
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
1645
|
+
| `{${string}}`;
|
|
1496
1646
|
|
|
1497
1647
|
/**
|
|
1498
1648
|
* Measures of the data.
|
|
@@ -1500,7 +1650,8 @@ declare namespace sap {
|
|
|
1500
1650
|
measures?:
|
|
1501
1651
|
| sap.chart.data.Measure[]
|
|
1502
1652
|
| sap.chart.data.Measure
|
|
1503
|
-
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
1653
|
+
| sap.ui.base.ManagedObject.AggregationBindingInfo
|
|
1654
|
+
| `{${string}}`;
|
|
1504
1655
|
|
|
1505
1656
|
/**
|
|
1506
1657
|
* fired after a drill-down operation
|
|
@@ -1744,6 +1895,8 @@ declare namespace sap {
|
|
|
1744
1895
|
* contained in `oClassInfo`.
|
|
1745
1896
|
*
|
|
1746
1897
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.viz.ui5.controls.common.BaseControl.extend}.
|
|
1898
|
+
*
|
|
1899
|
+
* @returns Created class / constructor function
|
|
1747
1900
|
*/
|
|
1748
1901
|
static extend<T extends Record<string, unknown>>(
|
|
1749
1902
|
/**
|
|
@@ -1762,6 +1915,8 @@ declare namespace sap {
|
|
|
1762
1915
|
): Function;
|
|
1763
1916
|
/**
|
|
1764
1917
|
* Returns a metadata object for class sap.chart.Chart.
|
|
1918
|
+
*
|
|
1919
|
+
* @returns Metadata object describing this class
|
|
1765
1920
|
*/
|
|
1766
1921
|
static getMetadata(): sap.ui.core.ElementMetadata;
|
|
1767
1922
|
/**
|
|
@@ -1775,6 +1930,8 @@ declare namespace sap {
|
|
|
1775
1930
|
* Render a chart with time axis when the dimension type is {@link sap.chart.data.TimeDimension}. Please
|
|
1776
1931
|
* be advised that time axis is supported with limited chart types (column, line, combination, stacked_column,
|
|
1777
1932
|
* bubble, scatter, dual_combination, vertical_bullet, waterfall).
|
|
1933
|
+
*
|
|
1934
|
+
* @returns Reference to this in order to allow method chaining
|
|
1778
1935
|
*/
|
|
1779
1936
|
addDimension(
|
|
1780
1937
|
/**
|
|
@@ -1784,6 +1941,8 @@ declare namespace sap {
|
|
|
1784
1941
|
): this;
|
|
1785
1942
|
/**
|
|
1786
1943
|
* Adds some measure to the aggregation {@link #getMeasures measures}.
|
|
1944
|
+
*
|
|
1945
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1787
1946
|
*/
|
|
1788
1947
|
addMeasure(
|
|
1789
1948
|
/**
|
|
@@ -1809,6 +1968,8 @@ declare namespace sap {
|
|
|
1809
1968
|
*
|
|
1810
1969
|
*
|
|
1811
1970
|
* Only works when selectionBehavior is "CATEGORY"
|
|
1971
|
+
*
|
|
1972
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1812
1973
|
*/
|
|
1813
1974
|
addSelectedCategories(
|
|
1814
1975
|
/**
|
|
@@ -1831,6 +1992,8 @@ declare namespace sap {
|
|
|
1831
1992
|
*
|
|
1832
1993
|
*
|
|
1833
1994
|
* Only works when selectionBehavior is "DATAPOINT"
|
|
1995
|
+
*
|
|
1996
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1834
1997
|
*/
|
|
1835
1998
|
addSelectedDataPoints(
|
|
1836
1999
|
/**
|
|
@@ -1856,6 +2019,8 @@ declare namespace sap {
|
|
|
1856
2019
|
*
|
|
1857
2020
|
*
|
|
1858
2021
|
* Only works when selectionBehavior is "SERIES"
|
|
2022
|
+
*
|
|
2023
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1859
2024
|
*/
|
|
1860
2025
|
addSelectedSeries(
|
|
1861
2026
|
/**
|
|
@@ -1871,6 +2036,8 @@ declare namespace sap {
|
|
|
1871
2036
|
*
|
|
1872
2037
|
* Event fires when certain data point(s) is(are) deselected, data context of deselected item(s) would be
|
|
1873
2038
|
* passed in
|
|
2039
|
+
*
|
|
2040
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1874
2041
|
*/
|
|
1875
2042
|
attachDeselectData(
|
|
1876
2043
|
/**
|
|
@@ -1895,6 +2062,8 @@ declare namespace sap {
|
|
|
1895
2062
|
*
|
|
1896
2063
|
* Event fires when certain data point(s) is(are) deselected, data context of deselected item(s) would be
|
|
1897
2064
|
* passed in
|
|
2065
|
+
*
|
|
2066
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1898
2067
|
*/
|
|
1899
2068
|
attachDeselectData(
|
|
1900
2069
|
/**
|
|
@@ -1913,6 +2082,8 @@ declare namespace sap {
|
|
|
1913
2082
|
* otherwise it will be bound to this `sap.chart.Chart` itself.
|
|
1914
2083
|
*
|
|
1915
2084
|
* fired after a drill-down operation
|
|
2085
|
+
*
|
|
2086
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1916
2087
|
*/
|
|
1917
2088
|
attachDrilledDown(
|
|
1918
2089
|
/**
|
|
@@ -1936,6 +2107,8 @@ declare namespace sap {
|
|
|
1936
2107
|
* otherwise it will be bound to this `sap.chart.Chart` itself.
|
|
1937
2108
|
*
|
|
1938
2109
|
* fired after a drill-down operation
|
|
2110
|
+
*
|
|
2111
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1939
2112
|
*/
|
|
1940
2113
|
attachDrilledDown(
|
|
1941
2114
|
/**
|
|
@@ -1954,6 +2127,8 @@ declare namespace sap {
|
|
|
1954
2127
|
* otherwise it will be bound to this `sap.chart.Chart` itself.
|
|
1955
2128
|
*
|
|
1956
2129
|
* fired after a drill-up operation
|
|
2130
|
+
*
|
|
2131
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1957
2132
|
*/
|
|
1958
2133
|
attachDrilledUp(
|
|
1959
2134
|
/**
|
|
@@ -1977,6 +2152,8 @@ declare namespace sap {
|
|
|
1977
2152
|
* otherwise it will be bound to this `sap.chart.Chart` itself.
|
|
1978
2153
|
*
|
|
1979
2154
|
* fired after a drill-up operation
|
|
2155
|
+
*
|
|
2156
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1980
2157
|
*/
|
|
1981
2158
|
attachDrilledUp(
|
|
1982
2159
|
/**
|
|
@@ -1997,6 +2174,8 @@ declare namespace sap {
|
|
|
1997
2174
|
*
|
|
1998
2175
|
* Event fires when drill stack changed. API that relies on drill stack like {@link #drillDown}, {@link
|
|
1999
2176
|
* #drillUp} shall be called in this event or after chart is rendered
|
|
2177
|
+
*
|
|
2178
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2000
2179
|
*/
|
|
2001
2180
|
attachDrillStackChanged(
|
|
2002
2181
|
/**
|
|
@@ -2022,6 +2201,8 @@ declare namespace sap {
|
|
|
2022
2201
|
*
|
|
2023
2202
|
* Event fires when drill stack changed. API that relies on drill stack like {@link #drillDown}, {@link
|
|
2024
2203
|
* #drillUp} shall be called in this event or after chart is rendered
|
|
2204
|
+
*
|
|
2205
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2025
2206
|
*/
|
|
2026
2207
|
attachDrillStackChanged(
|
|
2027
2208
|
/**
|
|
@@ -2041,6 +2222,8 @@ declare namespace sap {
|
|
|
2041
2222
|
* otherwise it will be bound to this `sap.chart.Chart` itself.
|
|
2042
2223
|
*
|
|
2043
2224
|
* Event fires when the rendering ends.
|
|
2225
|
+
*
|
|
2226
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2044
2227
|
*/
|
|
2045
2228
|
attachRenderComplete(
|
|
2046
2229
|
/**
|
|
@@ -2065,6 +2248,8 @@ declare namespace sap {
|
|
|
2065
2248
|
* otherwise it will be bound to this `sap.chart.Chart` itself.
|
|
2066
2249
|
*
|
|
2067
2250
|
* Event fires when the rendering ends.
|
|
2251
|
+
*
|
|
2252
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2068
2253
|
*/
|
|
2069
2254
|
attachRenderComplete(
|
|
2070
2255
|
/**
|
|
@@ -2084,6 +2269,8 @@ declare namespace sap {
|
|
|
2084
2269
|
*
|
|
2085
2270
|
* Event fires when certain data point(s) is(are) selected, data context of selected item(s) would be passed
|
|
2086
2271
|
* in.
|
|
2272
|
+
*
|
|
2273
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2087
2274
|
*/
|
|
2088
2275
|
attachSelectData(
|
|
2089
2276
|
/**
|
|
@@ -2108,6 +2295,8 @@ declare namespace sap {
|
|
|
2108
2295
|
*
|
|
2109
2296
|
* Event fires when certain data point(s) is(are) selected, data context of selected item(s) would be passed
|
|
2110
2297
|
* in.
|
|
2298
|
+
*
|
|
2299
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2111
2300
|
*/
|
|
2112
2301
|
attachSelectData(
|
|
2113
2302
|
/**
|
|
@@ -2127,6 +2316,8 @@ declare namespace sap {
|
|
|
2127
2316
|
* otherwise it will be bound to this `sap.chart.Chart` itself.
|
|
2128
2317
|
*
|
|
2129
2318
|
* Event fires when fixed scale is turned off by adding or removing dimension
|
|
2319
|
+
*
|
|
2320
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2130
2321
|
*/
|
|
2131
2322
|
attachValueAxisFixedScaleTurnedOff(
|
|
2132
2323
|
/**
|
|
@@ -2151,6 +2342,8 @@ declare namespace sap {
|
|
|
2151
2342
|
* otherwise it will be bound to this `sap.chart.Chart` itself.
|
|
2152
2343
|
*
|
|
2153
2344
|
* Event fires when fixed scale is turned off by adding or removing dimension
|
|
2345
|
+
*
|
|
2346
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2154
2347
|
*/
|
|
2155
2348
|
attachValueAxisFixedScaleTurnedOff(
|
|
2156
2349
|
/**
|
|
@@ -2170,6 +2363,8 @@ declare namespace sap {
|
|
|
2170
2363
|
*
|
|
2171
2364
|
* **NOTE:** If the {@link sap.ui.model.odata.v4.ODataListBinding list binding} is suspended, data related
|
|
2172
2365
|
* requests in Chart will be impacted, and the corresponding operations might not work as expected.
|
|
2366
|
+
*
|
|
2367
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2173
2368
|
*/
|
|
2174
2369
|
bindData(
|
|
2175
2370
|
/**
|
|
@@ -2185,16 +2380,22 @@ declare namespace sap {
|
|
|
2185
2380
|
/**
|
|
2186
2381
|
* Destroys all the dimensions in the aggregation dimensions, only works when the property isAnalytical
|
|
2187
2382
|
* is true.
|
|
2383
|
+
*
|
|
2384
|
+
* @returns Reference to this in order to allow method chaining
|
|
2188
2385
|
*/
|
|
2189
2386
|
destroyDimensions(): this;
|
|
2190
2387
|
/**
|
|
2191
2388
|
* Destroys all the measures in the aggregation {@link #getMeasures measures}.
|
|
2389
|
+
*
|
|
2390
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2192
2391
|
*/
|
|
2193
2392
|
destroyMeasures(): this;
|
|
2194
2393
|
/**
|
|
2195
2394
|
* Detaches event handler `fnFunction` from the {@link #event:deselectData deselectData} event of this `sap.chart.Chart`.
|
|
2196
2395
|
*
|
|
2197
2396
|
* The passed function and listener object must match the ones used for event registration.
|
|
2397
|
+
*
|
|
2398
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2198
2399
|
*/
|
|
2199
2400
|
detachDeselectData(
|
|
2200
2401
|
/**
|
|
@@ -2210,6 +2411,8 @@ declare namespace sap {
|
|
|
2210
2411
|
* Detaches event handler `fnFunction` from the {@link #event:drilledDown drilledDown} event of this `sap.chart.Chart`.
|
|
2211
2412
|
*
|
|
2212
2413
|
* The passed function and listener object must match the ones used for event registration.
|
|
2414
|
+
*
|
|
2415
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2213
2416
|
*/
|
|
2214
2417
|
detachDrilledDown(
|
|
2215
2418
|
/**
|
|
@@ -2225,6 +2428,8 @@ declare namespace sap {
|
|
|
2225
2428
|
* Detaches event handler `fnFunction` from the {@link #event:drilledUp drilledUp} event of this `sap.chart.Chart`.
|
|
2226
2429
|
*
|
|
2227
2430
|
* The passed function and listener object must match the ones used for event registration.
|
|
2431
|
+
*
|
|
2432
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2228
2433
|
*/
|
|
2229
2434
|
detachDrilledUp(
|
|
2230
2435
|
/**
|
|
@@ -2241,6 +2446,8 @@ declare namespace sap {
|
|
|
2241
2446
|
* of this `sap.chart.Chart`.
|
|
2242
2447
|
*
|
|
2243
2448
|
* The passed function and listener object must match the ones used for event registration.
|
|
2449
|
+
*
|
|
2450
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2244
2451
|
*/
|
|
2245
2452
|
detachDrillStackChanged(
|
|
2246
2453
|
/**
|
|
@@ -2257,6 +2464,8 @@ declare namespace sap {
|
|
|
2257
2464
|
* `sap.chart.Chart`.
|
|
2258
2465
|
*
|
|
2259
2466
|
* The passed function and listener object must match the ones used for event registration.
|
|
2467
|
+
*
|
|
2468
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2260
2469
|
*/
|
|
2261
2470
|
detachRenderComplete(
|
|
2262
2471
|
/**
|
|
@@ -2272,6 +2481,8 @@ declare namespace sap {
|
|
|
2272
2481
|
* Detaches event handler `fnFunction` from the {@link #event:selectData selectData} event of this `sap.chart.Chart`.
|
|
2273
2482
|
*
|
|
2274
2483
|
* The passed function and listener object must match the ones used for event registration.
|
|
2484
|
+
*
|
|
2485
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2275
2486
|
*/
|
|
2276
2487
|
detachSelectData(
|
|
2277
2488
|
/**
|
|
@@ -2288,6 +2499,8 @@ declare namespace sap {
|
|
|
2288
2499
|
* event of this `sap.chart.Chart`.
|
|
2289
2500
|
*
|
|
2290
2501
|
* The passed function and listener object must match the ones used for event registration.
|
|
2502
|
+
*
|
|
2503
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2291
2504
|
*/
|
|
2292
2505
|
detachValueAxisFixedScaleTurnedOff(
|
|
2293
2506
|
/**
|
|
@@ -2329,6 +2542,8 @@ declare namespace sap {
|
|
|
2329
2542
|
/**
|
|
2330
2543
|
* Export the current chart as SVG String. The chart is ready to be exported to SVG ONLY after the initialization
|
|
2331
2544
|
* is finished. Any attempt to export to SVG before that will result in an empty SVG string.
|
|
2545
|
+
*
|
|
2546
|
+
* @returns the SVG string of the current viz or empty svg if error occurs.
|
|
2332
2547
|
*/
|
|
2333
2548
|
exportToSVGString(
|
|
2334
2549
|
/**
|
|
@@ -2347,6 +2562,8 @@ declare namespace sap {
|
|
|
2347
2562
|
): string;
|
|
2348
2563
|
/**
|
|
2349
2564
|
* Fires event {@link #event:deselectData deselectData} to attached listeners.
|
|
2565
|
+
*
|
|
2566
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2350
2567
|
*/
|
|
2351
2568
|
fireDeselectData(
|
|
2352
2569
|
/**
|
|
@@ -2356,6 +2573,8 @@ declare namespace sap {
|
|
|
2356
2573
|
): this;
|
|
2357
2574
|
/**
|
|
2358
2575
|
* Fires event {@link #event:drilledDown drilledDown} to attached listeners.
|
|
2576
|
+
*
|
|
2577
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2359
2578
|
*/
|
|
2360
2579
|
fireDrilledDown(
|
|
2361
2580
|
/**
|
|
@@ -2370,6 +2589,8 @@ declare namespace sap {
|
|
|
2370
2589
|
): this;
|
|
2371
2590
|
/**
|
|
2372
2591
|
* Fires event {@link #event:drilledUp drilledUp} to attached listeners.
|
|
2592
|
+
*
|
|
2593
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2373
2594
|
*/
|
|
2374
2595
|
fireDrilledUp(
|
|
2375
2596
|
/**
|
|
@@ -2384,6 +2605,8 @@ declare namespace sap {
|
|
|
2384
2605
|
): this;
|
|
2385
2606
|
/**
|
|
2386
2607
|
* Fires event {@link #event:drillStackChanged drillStackChanged} to attached listeners.
|
|
2608
|
+
*
|
|
2609
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2387
2610
|
*/
|
|
2388
2611
|
fireDrillStackChanged(
|
|
2389
2612
|
/**
|
|
@@ -2393,6 +2616,8 @@ declare namespace sap {
|
|
|
2393
2616
|
): this;
|
|
2394
2617
|
/**
|
|
2395
2618
|
* Fires event {@link #event:renderComplete renderComplete} to attached listeners.
|
|
2619
|
+
*
|
|
2620
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2396
2621
|
*/
|
|
2397
2622
|
fireRenderComplete(
|
|
2398
2623
|
/**
|
|
@@ -2402,6 +2627,8 @@ declare namespace sap {
|
|
|
2402
2627
|
): this;
|
|
2403
2628
|
/**
|
|
2404
2629
|
* Fires event {@link #event:selectData selectData} to attached listeners.
|
|
2630
|
+
*
|
|
2631
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2405
2632
|
*/
|
|
2406
2633
|
fireSelectData(
|
|
2407
2634
|
/**
|
|
@@ -2411,6 +2638,8 @@ declare namespace sap {
|
|
|
2411
2638
|
): this;
|
|
2412
2639
|
/**
|
|
2413
2640
|
* Fires event {@link #event:valueAxisFixedScaleTurnedOff valueAxisFixedScaleTurnedOff} to attached listeners.
|
|
2641
|
+
*
|
|
2642
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2414
2643
|
*/
|
|
2415
2644
|
fireValueAxisFixedScaleTurnedOff(
|
|
2416
2645
|
/**
|
|
@@ -2451,6 +2680,9 @@ declare namespace sap {
|
|
|
2451
2680
|
* }
|
|
2452
2681
|
* }
|
|
2453
2682
|
* ```
|
|
2683
|
+
*
|
|
2684
|
+
*
|
|
2685
|
+
* @returns Value of property `activeColoring`
|
|
2454
2686
|
*/
|
|
2455
2687
|
getActiveColoring(): object;
|
|
2456
2688
|
/**
|
|
@@ -2476,6 +2708,9 @@ declare namespace sap {
|
|
|
2476
2708
|
* }, ...]
|
|
2477
2709
|
* }
|
|
2478
2710
|
* ```
|
|
2711
|
+
*
|
|
2712
|
+
*
|
|
2713
|
+
* @returns chart types and errors for unavailable chart types, grouped by availability
|
|
2479
2714
|
*/
|
|
2480
2715
|
getAvailableChartTypes(): object;
|
|
2481
2716
|
/**
|
|
@@ -2484,6 +2719,8 @@ declare namespace sap {
|
|
|
2484
2719
|
* Type of the Chart.
|
|
2485
2720
|
*
|
|
2486
2721
|
* Default value is `"bar"`.
|
|
2722
|
+
*
|
|
2723
|
+
* @returns Value of property `chartType`
|
|
2487
2724
|
*/
|
|
2488
2725
|
getChartType(): string;
|
|
2489
2726
|
/**
|
|
@@ -2514,12 +2751,16 @@ declare namespace sap {
|
|
|
2514
2751
|
* {@link sap.chart.ColoringType.Criticality}
|
|
2515
2752
|
* {@link sap.chart.ColoringType.Emphasis}
|
|
2516
2753
|
* for detailed usage
|
|
2754
|
+
*
|
|
2755
|
+
* @returns Value of property `colorings`
|
|
2517
2756
|
*/
|
|
2518
2757
|
getColorings(): object;
|
|
2519
2758
|
/**
|
|
2520
2759
|
* Gets current value of property {@link #getCustomMessages customMessages}.
|
|
2521
2760
|
*
|
|
2522
2761
|
* Chart custom messages.
|
|
2762
|
+
*
|
|
2763
|
+
* @returns Value of property `customMessages`
|
|
2523
2764
|
*/
|
|
2524
2765
|
getCustomMessages(): object;
|
|
2525
2766
|
/**
|
|
@@ -2529,6 +2770,8 @@ declare namespace sap {
|
|
|
2529
2770
|
getData(): void;
|
|
2530
2771
|
/**
|
|
2531
2772
|
* Return Dimension with the given name.
|
|
2773
|
+
*
|
|
2774
|
+
* @returns Dimension of the specified name.
|
|
2532
2775
|
*/
|
|
2533
2776
|
getDimensionByName(
|
|
2534
2777
|
/**
|
|
@@ -2547,6 +2790,8 @@ declare namespace sap {
|
|
|
2547
2790
|
*
|
|
2548
2791
|
* NOTE: If {@link sap.chart.data.HierarchyDimension} is used when calling {@link #setVisibleDimensions},
|
|
2549
2792
|
* drill stack could not be determined synchronously. Listen to `drillStackChanged` event instead.
|
|
2793
|
+
*
|
|
2794
|
+
* @returns array of drill state objects
|
|
2550
2795
|
*/
|
|
2551
2796
|
getDrillStack(): Object[];
|
|
2552
2797
|
/**
|
|
@@ -2566,6 +2811,8 @@ declare namespace sap {
|
|
|
2566
2811
|
* notes for details.
|
|
2567
2812
|
*
|
|
2568
2813
|
* Default value is `false`.
|
|
2814
|
+
*
|
|
2815
|
+
* @returns Value of property `enablePagination`
|
|
2569
2816
|
*/
|
|
2570
2817
|
getEnablePagination(): boolean;
|
|
2571
2818
|
/**
|
|
@@ -2574,6 +2821,8 @@ declare namespace sap {
|
|
|
2574
2821
|
* Enable scaling factor.
|
|
2575
2822
|
*
|
|
2576
2823
|
* Default value is `false`.
|
|
2824
|
+
*
|
|
2825
|
+
* @returns Value of property `enableScalingFactor`
|
|
2577
2826
|
*/
|
|
2578
2827
|
getEnableScalingFactor(): boolean;
|
|
2579
2828
|
/**
|
|
@@ -2582,6 +2831,8 @@ declare namespace sap {
|
|
|
2582
2831
|
* Enable Stable color mode. To keep the same colors for the same dimension values or measure names.
|
|
2583
2832
|
*
|
|
2584
2833
|
* Default value is `false`.
|
|
2834
|
+
*
|
|
2835
|
+
* @returns Value of property `enableStableColor`
|
|
2585
2836
|
*/
|
|
2586
2837
|
getEnableStableColor(): boolean;
|
|
2587
2838
|
/**
|
|
@@ -2593,6 +2844,8 @@ declare namespace sap {
|
|
|
2593
2844
|
* and in selection results.
|
|
2594
2845
|
*
|
|
2595
2846
|
* Default value is `[]`.
|
|
2847
|
+
*
|
|
2848
|
+
* @returns Value of property `inResultDimensions`
|
|
2596
2849
|
*/
|
|
2597
2850
|
getInResultDimensions(): string[];
|
|
2598
2851
|
/**
|
|
@@ -2602,10 +2855,14 @@ declare namespace sap {
|
|
|
2602
2855
|
*
|
|
2603
2856
|
* The property isAnalytical will programmatically set according to data source. When the data source has
|
|
2604
2857
|
* an aggregated entity set, isAnalytical is true, otherwise it's false.
|
|
2858
|
+
*
|
|
2859
|
+
* @returns Value of property isAnalytical
|
|
2605
2860
|
*/
|
|
2606
2861
|
getIsAnalytical(): boolean;
|
|
2607
2862
|
/**
|
|
2608
2863
|
* Return Measure with the given name.
|
|
2864
|
+
*
|
|
2865
|
+
* @returns Measure of the specified name.
|
|
2609
2866
|
*/
|
|
2610
2867
|
getMeasureByName(
|
|
2611
2868
|
/**
|
|
@@ -2621,6 +2878,8 @@ declare namespace sap {
|
|
|
2621
2878
|
getMeasures(): sap.chart.data.Measure[];
|
|
2622
2879
|
/**
|
|
2623
2880
|
* return the scaling factor. Or return null when scaling factor is disable.
|
|
2881
|
+
*
|
|
2882
|
+
* @returns A scaling factor object or null
|
|
2624
2883
|
*/
|
|
2625
2884
|
getScalingFactor(): object;
|
|
2626
2885
|
/**
|
|
@@ -2641,6 +2900,8 @@ declare namespace sap {
|
|
|
2641
2900
|
*
|
|
2642
2901
|
*
|
|
2643
2902
|
* Return 0 and empty list if selectionBehavior is not "CATEGORY"
|
|
2903
|
+
*
|
|
2904
|
+
* @returns a total number of selected data points, and an array of category objects for selected categories.
|
|
2644
2905
|
*/
|
|
2645
2906
|
getSelectedCategories(): object;
|
|
2646
2907
|
/**
|
|
@@ -2666,6 +2927,8 @@ declare namespace sap {
|
|
|
2666
2927
|
*
|
|
2667
2928
|
*
|
|
2668
2929
|
* Only works when selectionBehavior is "DATAPOINT"
|
|
2930
|
+
*
|
|
2931
|
+
* @returns a total number of selected data points, and an array of datapoint objects.
|
|
2669
2932
|
*/
|
|
2670
2933
|
getSelectedDataPoints(): object;
|
|
2671
2934
|
/**
|
|
@@ -2686,6 +2949,9 @@ declare namespace sap {
|
|
|
2686
2949
|
*
|
|
2687
2950
|
*
|
|
2688
2951
|
* Return 0 and empty list if selectionBehavior is not "SERIES"
|
|
2952
|
+
*
|
|
2953
|
+
* @returns object containing a total number of selected data points, and an array of series objects for
|
|
2954
|
+
* selected series.
|
|
2689
2955
|
*/
|
|
2690
2956
|
getSelectedSeries(): object;
|
|
2691
2957
|
/**
|
|
@@ -2694,6 +2960,8 @@ declare namespace sap {
|
|
|
2694
2960
|
* Chart selection behavior.
|
|
2695
2961
|
*
|
|
2696
2962
|
* Default value is `DataPoint`.
|
|
2963
|
+
*
|
|
2964
|
+
* @returns Value of property `selectionBehavior`
|
|
2697
2965
|
*/
|
|
2698
2966
|
getSelectionBehavior(): sap.chart.SelectionBehavior;
|
|
2699
2967
|
/**
|
|
@@ -2702,10 +2970,14 @@ declare namespace sap {
|
|
|
2702
2970
|
* Chart selection mode.
|
|
2703
2971
|
*
|
|
2704
2972
|
* Default value is `Multi`.
|
|
2973
|
+
*
|
|
2974
|
+
* @returns Value of property `selectionMode`
|
|
2705
2975
|
*/
|
|
2706
2976
|
getSelectionMode(): sap.chart.SelectionMode;
|
|
2707
2977
|
/**
|
|
2708
2978
|
* Return all TimeDimensions from current Dimensions.
|
|
2979
|
+
*
|
|
2980
|
+
* @returns Dimensions which are instance of TimeDimension.
|
|
2709
2981
|
*/
|
|
2710
2982
|
getTimeDimensions(): any[];
|
|
2711
2983
|
/**
|
|
@@ -2713,6 +2985,8 @@ declare namespace sap {
|
|
|
2713
2985
|
*
|
|
2714
2986
|
* Configuration for initialization to VizControl. This property could only set via settings parameter in
|
|
2715
2987
|
* Constructor.
|
|
2988
|
+
*
|
|
2989
|
+
* @returns Value of property `uiConfig`
|
|
2716
2990
|
*/
|
|
2717
2991
|
getUiConfig(): object;
|
|
2718
2992
|
/**
|
|
@@ -2791,6 +3065,8 @@ declare namespace sap {
|
|
|
2791
3065
|
* {@link sap.chart.ScaleBehavior.AutoScale}
|
|
2792
3066
|
* {@link sap.chart.ScaleBehavior.FixedScale}
|
|
2793
3067
|
* for detailed usage
|
|
3068
|
+
*
|
|
3069
|
+
* @returns Value of property `valueAxisScale`
|
|
2794
3070
|
*/
|
|
2795
3071
|
getValueAxisScale(): object;
|
|
2796
3072
|
/**
|
|
@@ -2802,6 +3078,8 @@ declare namespace sap {
|
|
|
2802
3078
|
* Depending on chart type, insufficient number of visible `Dimension`s will cause error.
|
|
2803
3079
|
*
|
|
2804
3080
|
* Default value is `[]`.
|
|
3081
|
+
*
|
|
3082
|
+
* @returns Value of property `visibleDimensions`
|
|
2805
3083
|
*/
|
|
2806
3084
|
getVisibleDimensions(): string[];
|
|
2807
3085
|
/**
|
|
@@ -2812,6 +3090,8 @@ declare namespace sap {
|
|
|
2812
3090
|
* Depending on chart type, insufficient number of visible `Measure`s will cause errors.
|
|
2813
3091
|
*
|
|
2814
3092
|
* Default value is `[]`.
|
|
3093
|
+
*
|
|
3094
|
+
* @returns Value of property `visibleMeasures`
|
|
2815
3095
|
*/
|
|
2816
3096
|
getVisibleMeasures(): string[];
|
|
2817
3097
|
/**
|
|
@@ -2819,6 +3099,8 @@ declare namespace sap {
|
|
|
2819
3099
|
*
|
|
2820
3100
|
* Refer to chart property documentation for more
|
|
2821
3101
|
* details.
|
|
3102
|
+
*
|
|
3103
|
+
* @returns the Chart properties object
|
|
2822
3104
|
*/
|
|
2823
3105
|
getVizProperties(): object;
|
|
2824
3106
|
/**
|
|
@@ -2826,10 +3108,14 @@ declare namespace sap {
|
|
|
2826
3108
|
*
|
|
2827
3109
|
* Refer to chart property documentation for more
|
|
2828
3110
|
* details.
|
|
3111
|
+
*
|
|
3112
|
+
* @returns an array of scale objects
|
|
2829
3113
|
*/
|
|
2830
3114
|
getVizScales(): object[];
|
|
2831
3115
|
/**
|
|
2832
3116
|
* Get the UID for Chart. It supports other controls to connect to a viz instance.
|
|
3117
|
+
*
|
|
3118
|
+
* @returns Chart UID
|
|
2833
3119
|
*/
|
|
2834
3120
|
getVizUid(): string;
|
|
2835
3121
|
/**
|
|
@@ -2849,6 +3135,10 @@ declare namespace sap {
|
|
|
2849
3135
|
* "currentZoomLevel":0.16
|
|
2850
3136
|
* }
|
|
2851
3137
|
* ```
|
|
3138
|
+
*
|
|
3139
|
+
*
|
|
3140
|
+
* @returns The zooming enablement and current zooming level of chart.The zooming level is between 0 and
|
|
3141
|
+
* 1, and null when zooming isn't applicable.
|
|
2852
3142
|
*/
|
|
2853
3143
|
getZoomInfo(): object;
|
|
2854
3144
|
/**
|
|
@@ -2859,6 +3149,8 @@ declare namespace sap {
|
|
|
2859
3149
|
/**
|
|
2860
3150
|
* Checks for the provided `sap.chart.data.Dimension` in the aggregation {@link #getDimensions dimensions}.
|
|
2861
3151
|
* and returns its index if found or -1 otherwise.
|
|
3152
|
+
*
|
|
3153
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
2862
3154
|
*/
|
|
2863
3155
|
indexOfDimension(
|
|
2864
3156
|
/**
|
|
@@ -2869,6 +3161,8 @@ declare namespace sap {
|
|
|
2869
3161
|
/**
|
|
2870
3162
|
* Checks for the provided `sap.chart.data.Measure` in the aggregation {@link #getMeasures measures}. and
|
|
2871
3163
|
* returns its index if found or -1 otherwise.
|
|
3164
|
+
*
|
|
3165
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
2872
3166
|
*/
|
|
2873
3167
|
indexOfMeasure(
|
|
2874
3168
|
/**
|
|
@@ -2883,6 +3177,8 @@ declare namespace sap {
|
|
|
2883
3177
|
insertData(): void;
|
|
2884
3178
|
/**
|
|
2885
3179
|
* Inserts a dimension into the aggregation {@link #getDimensions dimensions}.
|
|
3180
|
+
*
|
|
3181
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2886
3182
|
*/
|
|
2887
3183
|
insertDimension(
|
|
2888
3184
|
/**
|
|
@@ -2898,6 +3194,8 @@ declare namespace sap {
|
|
|
2898
3194
|
): this;
|
|
2899
3195
|
/**
|
|
2900
3196
|
* Inserts a measure into the aggregation {@link #getMeasures measures}.
|
|
3197
|
+
*
|
|
3198
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2901
3199
|
*/
|
|
2902
3200
|
insertMeasure(
|
|
2903
3201
|
/**
|
|
@@ -2921,12 +3219,16 @@ declare namespace sap {
|
|
|
2921
3219
|
* true.
|
|
2922
3220
|
*
|
|
2923
3221
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
3222
|
+
*
|
|
3223
|
+
* @returns An array of the removed elements (might be empty)
|
|
2924
3224
|
*/
|
|
2925
3225
|
removeAllDimensions(): sap.chart.data.Dimension[];
|
|
2926
3226
|
/**
|
|
2927
3227
|
* Removes all the controls from the aggregation {@link #getMeasures measures}.
|
|
2928
3228
|
*
|
|
2929
3229
|
* Additionally, it unregisters them from the hosting UIArea.
|
|
3230
|
+
*
|
|
3231
|
+
* @returns An array of the removed elements (might be empty)
|
|
2930
3232
|
*/
|
|
2931
3233
|
removeAllMeasures(): sap.chart.data.Measure[];
|
|
2932
3234
|
/**
|
|
@@ -2937,6 +3239,8 @@ declare namespace sap {
|
|
|
2937
3239
|
/**
|
|
2938
3240
|
* Removes a dimension from the aggregation dimensions, remove a visible dimension is unsupported when the
|
|
2939
3241
|
* property isAnalytical is false.
|
|
3242
|
+
*
|
|
3243
|
+
* @returns The removed dimension or null
|
|
2940
3244
|
*/
|
|
2941
3245
|
removeDimension(
|
|
2942
3246
|
/**
|
|
@@ -2946,6 +3250,8 @@ declare namespace sap {
|
|
|
2946
3250
|
): sap.chart.data.Dimension;
|
|
2947
3251
|
/**
|
|
2948
3252
|
* Removes a measure from the aggregation {@link #getMeasures measures}.
|
|
3253
|
+
*
|
|
3254
|
+
* @returns The removed measure or `null`
|
|
2949
3255
|
*/
|
|
2950
3256
|
removeMeasure(
|
|
2951
3257
|
/**
|
|
@@ -2971,6 +3277,8 @@ declare namespace sap {
|
|
|
2971
3277
|
*
|
|
2972
3278
|
*
|
|
2973
3279
|
* Only works when selectionBehavior is "CATEGORY"
|
|
3280
|
+
*
|
|
3281
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2974
3282
|
*/
|
|
2975
3283
|
removeSelectedCategories(
|
|
2976
3284
|
/**
|
|
@@ -2993,6 +3301,8 @@ declare namespace sap {
|
|
|
2993
3301
|
*
|
|
2994
3302
|
*
|
|
2995
3303
|
* Only works when selectionBehavior is "DATAPOINT"
|
|
3304
|
+
*
|
|
3305
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2996
3306
|
*/
|
|
2997
3307
|
removeSelectedDataPoints(
|
|
2998
3308
|
/**
|
|
@@ -3018,6 +3328,8 @@ declare namespace sap {
|
|
|
3018
3328
|
*
|
|
3019
3329
|
*
|
|
3020
3330
|
* Only works when selectionBehavior is "SERIES"
|
|
3331
|
+
*
|
|
3332
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3021
3333
|
*/
|
|
3022
3334
|
removeSelectedSeries(
|
|
3023
3335
|
/**
|
|
@@ -3027,6 +3339,8 @@ declare namespace sap {
|
|
|
3027
3339
|
): this;
|
|
3028
3340
|
/**
|
|
3029
3341
|
* Reset to visible layout.
|
|
3342
|
+
*
|
|
3343
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3030
3344
|
*/
|
|
3031
3345
|
resetLayout(): this;
|
|
3032
3346
|
/**
|
|
@@ -3065,6 +3379,8 @@ declare namespace sap {
|
|
|
3065
3379
|
*
|
|
3066
3380
|
*
|
|
3067
3381
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3382
|
+
*
|
|
3383
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3068
3384
|
*/
|
|
3069
3385
|
setActiveColoring(
|
|
3070
3386
|
/**
|
|
@@ -3080,6 +3396,8 @@ declare namespace sap {
|
|
|
3080
3396
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3081
3397
|
*
|
|
3082
3398
|
* Default value is `"bar"`.
|
|
3399
|
+
*
|
|
3400
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3083
3401
|
*/
|
|
3084
3402
|
setChartType(
|
|
3085
3403
|
/**
|
|
@@ -3117,6 +3435,8 @@ declare namespace sap {
|
|
|
3117
3435
|
* for detailed usage
|
|
3118
3436
|
*
|
|
3119
3437
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3438
|
+
*
|
|
3439
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3120
3440
|
*/
|
|
3121
3441
|
setColorings(
|
|
3122
3442
|
/**
|
|
@@ -3170,6 +3490,8 @@ declare namespace sap {
|
|
|
3170
3490
|
* When called with a value of null or undefined, the default value of the property will be restored.
|
|
3171
3491
|
*
|
|
3172
3492
|
* Default value is false.
|
|
3493
|
+
*
|
|
3494
|
+
* @returns Reference to this in order to allow method chaining
|
|
3173
3495
|
*/
|
|
3174
3496
|
setEnablePagination(
|
|
3175
3497
|
/**
|
|
@@ -3185,6 +3507,8 @@ declare namespace sap {
|
|
|
3185
3507
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3186
3508
|
*
|
|
3187
3509
|
* Default value is `false`.
|
|
3510
|
+
*
|
|
3511
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3188
3512
|
*/
|
|
3189
3513
|
setEnableScalingFactor(
|
|
3190
3514
|
/**
|
|
@@ -3200,6 +3524,8 @@ declare namespace sap {
|
|
|
3200
3524
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3201
3525
|
*
|
|
3202
3526
|
* Default value is `false`.
|
|
3527
|
+
*
|
|
3528
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3203
3529
|
*/
|
|
3204
3530
|
setEnableStableColor(
|
|
3205
3531
|
/**
|
|
@@ -3218,6 +3544,8 @@ declare namespace sap {
|
|
|
3218
3544
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3219
3545
|
*
|
|
3220
3546
|
* Default value is `[]`.
|
|
3547
|
+
*
|
|
3548
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3221
3549
|
*/
|
|
3222
3550
|
setInResultDimensions(
|
|
3223
3551
|
/**
|
|
@@ -3247,6 +3575,8 @@ declare namespace sap {
|
|
|
3247
3575
|
*
|
|
3248
3576
|
*
|
|
3249
3577
|
* Only works when selectionBehavior is "CATEGORY"
|
|
3578
|
+
*
|
|
3579
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3250
3580
|
*/
|
|
3251
3581
|
setSelectedCategories(
|
|
3252
3582
|
/**
|
|
@@ -3269,6 +3599,8 @@ declare namespace sap {
|
|
|
3269
3599
|
*
|
|
3270
3600
|
*
|
|
3271
3601
|
* Only works when selectionBehavior is "DATAPOINT"
|
|
3602
|
+
*
|
|
3603
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3272
3604
|
*/
|
|
3273
3605
|
setSelectedDataPoints(
|
|
3274
3606
|
/**
|
|
@@ -3294,6 +3626,8 @@ declare namespace sap {
|
|
|
3294
3626
|
*
|
|
3295
3627
|
*
|
|
3296
3628
|
* Only works when selectionBehavior is "SERIES"
|
|
3629
|
+
*
|
|
3630
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3297
3631
|
*/
|
|
3298
3632
|
setSelectedSeries(
|
|
3299
3633
|
/**
|
|
@@ -3309,6 +3643,8 @@ declare namespace sap {
|
|
|
3309
3643
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3310
3644
|
*
|
|
3311
3645
|
* Default value is `DataPoint`.
|
|
3646
|
+
*
|
|
3647
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3312
3648
|
*/
|
|
3313
3649
|
setSelectionBehavior(
|
|
3314
3650
|
/**
|
|
@@ -3324,6 +3660,8 @@ declare namespace sap {
|
|
|
3324
3660
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3325
3661
|
*
|
|
3326
3662
|
* Default value is `Multi`.
|
|
3663
|
+
*
|
|
3664
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3327
3665
|
*/
|
|
3328
3666
|
setSelectionMode(
|
|
3329
3667
|
/**
|
|
@@ -3434,6 +3772,8 @@ declare namespace sap {
|
|
|
3434
3772
|
* for detailed usage
|
|
3435
3773
|
*
|
|
3436
3774
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3775
|
+
*
|
|
3776
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3437
3777
|
*/
|
|
3438
3778
|
setValueAxisScale(
|
|
3439
3779
|
/**
|
|
@@ -3452,6 +3792,8 @@ declare namespace sap {
|
|
|
3452
3792
|
* When called with a value of null or undefined, the default value of the property will be restored.
|
|
3453
3793
|
*
|
|
3454
3794
|
* Default value is [].
|
|
3795
|
+
*
|
|
3796
|
+
* @returns Reference to this in order to allow method chaining
|
|
3455
3797
|
*/
|
|
3456
3798
|
setVisibleDimensions(
|
|
3457
3799
|
/**
|
|
@@ -3469,6 +3811,8 @@ declare namespace sap {
|
|
|
3469
3811
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3470
3812
|
*
|
|
3471
3813
|
* Default value is `[]`.
|
|
3814
|
+
*
|
|
3815
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3472
3816
|
*/
|
|
3473
3817
|
setVisibleMeasures(
|
|
3474
3818
|
/**
|
|
@@ -3506,6 +3850,8 @@ declare namespace sap {
|
|
|
3506
3850
|
): this;
|
|
3507
3851
|
/**
|
|
3508
3852
|
* Unbinds aggregation {@link #getData data} from model data.
|
|
3853
|
+
*
|
|
3854
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3509
3855
|
*/
|
|
3510
3856
|
unbindData(): this;
|
|
3511
3857
|
/**
|