@sapui5/ts-types 1.120.7 → 1.121.0

package/types/sap.chart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.7
+// For Library Version: 1.121.0
 
 declare namespace sap {
   /**
@@ -12,6 +12,7 @@ declare namespace sap {
       /**
        * Get the Dimensions and Measures layout for a certain ChartType with provided Dimensions and Measures.
        *
+       *
        * @returns the chart layout object of the following form:
        * ```javascript
        *
@@ -39,6 +40,7 @@ declare namespace sap {
       /**
        * Returns all chart types currently supported by chart control (subset of viz types).
        *
+       *
        * @returns a map with chartType as key, localized chart name as value.
        */
       function getChartTypes(): object;
@@ -70,6 +72,8 @@ declare namespace sap {
       }
       /**
        * Enumeration for supported Gradation diverging color scheme in analytical chart
+       *
+       * This enum is part of the 'sap/chart/library' module export and must be accessed by the property 'coloring.GradationDivergingColorScheme'.
        */
       enum GradationDivergingColorScheme {
         /**
@@ -95,6 +99,8 @@ declare namespace sap {
       }
       /**
        * Enumeration for supported Gradation color saturation in analytical chart
+       *
+       * This enum is part of the 'sap/chart/library' module export and must be accessed by the property 'coloring.GradationSaturation'.
        */
       enum GradationSaturation {
         /**
@@ -108,6 +114,8 @@ declare namespace sap {
       }
       /**
        * Enumeration for supported Gradation single color scheme in analytical chart
+       *
+       * This enum is part of the 'sap/chart/library' module export and must be accessed by the property 'coloring.GradationSingleColorScheme'.
        */
       enum GradationSingleColorScheme {
         /**
@@ -125,6 +133,8 @@ declare namespace sap {
       }
       /**
        * Enumeration for supported Gradation target color scheme in analytical chart
+       *
+       * This enum is part of the 'sap/chart/library' module export and must be accessed by the property 'coloring.GradationTargetColorScheme'.
        */
       enum GradationTargetColorScheme {
         /**
@@ -134,6 +144,8 @@ declare namespace sap {
       }
       /**
        * Enumeration for supported ImprovementDirection types in analytical chart
+       *
+       * This enum is part of the 'sap/chart/library' module export and must be accessed by the property 'coloring.ImprovementDirectionType'.
        */
       enum ImprovementDirectionType {
         /**
@@ -279,9 +291,9 @@ declare namespace sap {
         unitBinding?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
         /**
-         * @deprecated - Please use {@link sap.chart.Chart#setVizProperties} to set related formatStrings instead.
-         *
          * A (core UI5) format pattern to be used by the formatter to format the measure value.
+         *
+         * @deprecated - Please use {@link sap.chart.Chart#setVizProperties} to set related formatStrings instead.
          */
         valueFormat?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
@@ -335,10 +347,10 @@ declare namespace sap {
           | `{${string}}`;
 
         /**
+         * The analytical extra information
+         *
          * @since 1.63
          * @experimental
-         *
-         * The analytical extra information
          */
         analyticalInfo?:
           | object
@@ -384,8 +396,6 @@ declare namespace sap {
       }
 
       /**
-       * @since 1.32.0
-       *
        * Definition of a single dimension in a chart
        *
        *   chartType binding rules   pie, donut All
@@ -393,6 +403,8 @@ declare namespace sap {
        * with role category are assigned to feed uid “shape”.   heatmap All dimensions
        * with role “series” and “category2” are assigned to the feed uid “categoryAxis2”.   treemap
        * All dimensions are assigned to the feed uid “categoryAxis” in the default sequence.
+       *
+       * @since 1.32.0
        */
       class Dimension extends sap.ui.core.Element {
         /**
@@ -432,6 +444,7 @@ declare namespace sap {
          *
          * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
          *
+         *
          * @returns Created class / constructor function
          */
         static extend<T extends Record<string, unknown>>(
@@ -452,6 +465,7 @@ declare namespace sap {
         /**
          * Returns a metadata object for class sap.chart.data.Dimension.
          *
+         *
          * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.core.ElementMetadata;
@@ -463,6 +477,7 @@ declare namespace sap {
          *
          * Default value is `true`.
          *
+         *
          * @returns Value of property `displayText`
          */
         getDisplayText(): boolean;
@@ -475,6 +490,7 @@ declare namespace sap {
          * **NOTE:** This property was bound internally if automatically created via metadata of oData service and
          * please call "unbindProperty" before setting.
          *
+         *
          * @returns Value of property `label`
          */
         getLabel(): string;
@@ -483,6 +499,7 @@ declare namespace sap {
          *
          * Property in the "data" model holding the (always unique) Dimension key.
          *
+         *
          * @returns Value of property `name`
          */
         getName(): string;
@@ -508,6 +525,7 @@ declare namespace sap {
          *
          * Default value is `"category"`.
          *
+         *
          * @returns Value of property `role`
          */
         getRole(): string;
@@ -518,6 +536,7 @@ declare namespace sap {
          * specified, this property takes precedence over the "textProperty" property of the Dimension. Dimension
          * key value and the corresponding text will be passed to the supplied function as parameters.
          *
+         *
          * @returns Value of property `textFormatter`
          */
         getTextFormatter(): Function;
@@ -530,6 +549,7 @@ declare namespace sap {
          * **NOTE:** This property was bound internally if automatically created via metadata of oData service and
          * please call "unbindProperty" before setting.
          *
+         *
          * @returns Value of property `textProperty`
          */
         getTextProperty(): string;
@@ -543,6 +563,7 @@ declare namespace sap {
          *
          * Default value is `true`.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setDisplayText(
@@ -562,6 +583,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setLabel(
@@ -577,6 +599,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setName(
@@ -609,6 +632,7 @@ declare namespace sap {
          *
          * Default value is `"category"`.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setRole(
@@ -626,6 +650,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setTextFormatter(
@@ -645,6 +670,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setTextProperty(
@@ -655,9 +681,9 @@ declare namespace sap {
         ): this;
       }
       /**
-       * @since 1.54.0
-       *
        * Definition of a single hierarchy dimension in a chart
+       *
+       * @since 1.54.0
        */
       class HierarchyDimension extends sap.chart.data.Dimension {
         /**
@@ -697,6 +723,7 @@ declare namespace sap {
          *
          * `oClassInfo` might contain the same kind of information as described in {@link sap.chart.data.Dimension.extend}.
          *
+         *
          * @returns Created class / constructor function
          */
         static extend<T extends Record<string, unknown>>(
@@ -717,6 +744,7 @@ declare namespace sap {
         /**
          * Returns a metadata object for class sap.chart.data.HierarchyDimension.
          *
+         *
          * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.core.ElementMetadata;
@@ -729,6 +757,7 @@ declare namespace sap {
          *
          * Default value is `0`.
          *
+         *
          * @returns Value of property `level`
          */
         getLevel(): int;
@@ -743,6 +772,7 @@ declare namespace sap {
          *
          * Default value is `0`.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setLevel(
@@ -753,8 +783,6 @@ declare namespace sap {
         ): this;
       }
       /**
-       * @since 1.32.0
-       *
        * Definition of a single measure in a chart
        *
        *   chartType binding rules   pie, donut The
@@ -771,6 +799,8 @@ declare namespace sap {
        * is assigned to the feed uid “color”. The other measure is assigned to feed uid “weight”.
        * ..dual.. At least one measure is assigned to each of the feed uids “valueAxis” and “valueAxis2”,
        * according to the general rule.
+       *
+       * @since 1.32.0
        */
       class Measure extends sap.ui.core.Element {
         /**
@@ -810,6 +840,7 @@ declare namespace sap {
          *
          * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
          *
+         *
          * @returns Created class / constructor function
          */
         static extend<T extends Record<string, unknown>>(
@@ -830,17 +861,18 @@ declare namespace sap {
         /**
          * Returns a metadata object for class sap.chart.data.Measure.
          *
+         *
          * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.core.ElementMetadata;
         /**
-         * @since 1.63
-         * @experimental
-         *
          * Gets current value of property {@link #getAnalyticalInfo analyticalInfo}.
          *
          * The analytical extra information
          *
+         * @since 1.63
+         * @experimental
+         *
          * @returns Value of property `analyticalInfo`
          */
         getAnalyticalInfo(): object;
@@ -850,6 +882,7 @@ declare namespace sap {
          * Label for the Measure, either as a string literal or by a pointer using the binding syntax to some property
          * containing the label.
          *
+         *
          * @returns Value of property `label`
          */
         getLabel(): string;
@@ -858,6 +891,7 @@ declare namespace sap {
          *
          * Property in the "data" model holding the raw measure value.
          *
+         *
          * @returns Value of property `name`
          */
         getName(): string;
@@ -886,6 +920,7 @@ declare namespace sap {
          *
          * Default value is `"axis1"`.
          *
+         *
          * @returns Value of property `role`
          */
         getRole(): string;
@@ -897,6 +932,7 @@ declare namespace sap {
          * 	 - "projectedValueMeasure" identifing the projected value measure, and
          * 	 - "referenceValueMeasure" identifing the reference value measure.
          *
+         *
          * @returns Value of property `semanticallyRelatedMeasures`
          */
         getSemanticallyRelatedMeasures(): object;
@@ -914,6 +950,7 @@ declare namespace sap {
          *
          * Default value is `Actual`.
          *
+         *
          * @returns Value of property `semantics`
          */
         getSemantics(): sap.chart.data.MeasureSemantics;
@@ -925,29 +962,30 @@ declare namespace sap {
          * tooltip and chart popover. NOTE: To work properly, the unit field must be set as visible dimension in
          * chart, and only one unit value exists for any visible dimension value combination.
          *
+         *
          * @returns Value of property `unitBinding`
          */
         getUnitBinding(): string;
         /**
-         * @deprecated - Please use {@link sap.chart.Chart#setVizProperties} to set related formatStrings instead.
-         *
          * Gets current value of property {@link #getValueFormat valueFormat}.
          *
          * A (core UI5) format pattern to be used by the formatter to format the measure value.
          *
+         * @deprecated - Please use {@link sap.chart.Chart#setVizProperties} to set related formatStrings instead.
+         *
          * @returns Value of property `valueFormat`
          */
         getValueFormat(): string;
         /**
-         * @since 1.63
-         * @experimental
-         *
          * Sets a new value for property {@link #getAnalyticalInfo analyticalInfo}.
          *
          * The analytical extra information
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         * @since 1.63
+         * @experimental
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setAnalyticalInfo(
@@ -964,6 +1002,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setLabel(
@@ -979,6 +1018,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setName(
@@ -1014,6 +1054,7 @@ declare namespace sap {
          *
          * Default value is `"axis1"`.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setRole(
@@ -1032,6 +1073,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setSemanticallyRelatedMeasures(
@@ -1056,6 +1098,7 @@ declare namespace sap {
          *
          * Default value is `Actual`.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setSemantics(
@@ -1074,6 +1117,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setUnitBinding(
@@ -1083,14 +1127,14 @@ declare namespace sap {
           sUnitBinding: string
         ): this;
         /**
-         * @deprecated - Please use {@link sap.chart.Chart#setVizProperties} to set related formatStrings instead.
-         *
          * Sets a new value for property {@link #getValueFormat valueFormat}.
          *
          * A (core UI5) format pattern to be used by the formatter to format the measure value.
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         * @deprecated - Please use {@link sap.chart.Chart#setVizProperties} to set related formatStrings instead.
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setValueFormat(
@@ -1101,14 +1145,14 @@ declare namespace sap {
         ): this;
       }
       /**
-       * @since 1.38.0
-       *
        * Definition of a single time dimension in a chart
        *
        * If there is exactly one dimension with time semantics, then instead of line, time_line shall be used
        * (implicitly).
        *
        * TimeDmension is assigned to feed uid "timeAxis".
+       *
+       * @since 1.38.0
        */
       class TimeDimension extends sap.chart.data.Dimension {
         /**
@@ -1148,6 +1192,7 @@ declare namespace sap {
          *
          * `oClassInfo` might contain the same kind of information as described in {@link sap.chart.data.Dimension.extend}.
          *
+         *
          * @returns Created class / constructor function
          */
         static extend<T extends Record<string, unknown>>(
@@ -1168,6 +1213,7 @@ declare namespace sap {
         /**
          * Returns a metadata object for class sap.chart.data.TimeDimension.
          *
+         *
          * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.core.ElementMetadata;
@@ -1187,12 +1233,14 @@ declare namespace sap {
          * ```
          *
          *
+         *
          * @returns Value of property `fiscalYearPeriodCount`
          */
         getFiscalYearPeriodCount(): object;
         /**
          * Returns if UTC is used for the time dimension
          *
+         *
          * @returns true if the time dimension data is parsed in UTC, otherwise return false
          */
         getIsUTC(): boolean;
@@ -1201,6 +1249,7 @@ declare namespace sap {
          *
          * A time value (aligned with 'timeUnit') to indicate the start point of projected values.
          *
+         *
          * @returns Value of property `projectedValueStartTime`
          */
         getProjectedValueStartTime(): any;
@@ -1209,6 +1258,7 @@ declare namespace sap {
          *
          * Detailed unit infomation of TimeDimension. Please refer to {@link sap.chart.TimeUnitType TimeUnitType}.
          *
+         *
          * @returns Value of property `timeUnit`
          */
         getTimeUnit(): sap.chart.TimeUnitType;
@@ -1230,6 +1280,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setFiscalYearPeriodCount(
@@ -1254,6 +1305,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setProjectedValueStartTime(
@@ -1269,6 +1321,7 @@ declare namespace sap {
          *
          * When called with a value of `null` or `undefined`, the default value of the property will be restored.
          *
+         *
          * @returns Reference to `this` in order to allow method chaining
          */
         setTimeUnit(
@@ -1330,10 +1383,10 @@ declare namespace sap {
          */
         axis3 = "axis3",
         /**
-         * @deprecated - Please use other MeasureRoleType for specific usage.
-         *
          * Once used by Bullet Chart, but as this chart layout is configured via semantic patterns instead, "Asix4"
          * has no special usage from now on.
+         *
+         * @deprecated - Please use other MeasureRoleType for specific usage.
          */
         axis4 = "axis4",
       }
@@ -1901,9 +1954,9 @@ declare namespace sap {
     }
 
     /**
-     * @since 1.32.0
-     *
      * UI5 Chart control
+     *
+     * @since 1.32.0
      */
     class Chart extends sap.viz.ui5.controls.common.BaseControl {
       /**
@@ -1943,6 +1996,7 @@ declare namespace sap {
        *
        * `oClassInfo` might contain the same kind of information as described in {@link sap.viz.ui5.controls.common.BaseControl.extend}.
        *
+       *
        * @returns Created class / constructor function
        */
       static extend<T extends Record<string, unknown>>(
@@ -1963,6 +2017,7 @@ declare namespace sap {
       /**
        * Returns a metadata object for class sap.chart.Chart.
        *
+       *
        * @returns Metadata object describing this class
        */
       static getMetadata(): sap.ui.core.ElementMetadata;
@@ -1978,6 +2033,7 @@ declare namespace sap {
        * be advised that time axis is supported with limited chart types (column, line, combination, stacked_column,
        * bubble, scatter, dual_combination, vertical_bullet, waterfall).
        *
+       *
        * @returns Reference to this in order to allow method chaining
        */
       addDimension(
@@ -1989,6 +2045,7 @@ declare namespace sap {
       /**
        * Adds some measure to the aggregation {@link #getMeasures measures}.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       addMeasure(
@@ -2016,6 +2073,7 @@ declare namespace sap {
        *
        * Only works when selectionBehavior is "CATEGORY"
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       addSelectedCategories(
@@ -2040,6 +2098,7 @@ declare namespace sap {
        *
        * Only works when selectionBehavior is "DATAPOINT"
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       addSelectedDataPoints(
@@ -2067,6 +2126,7 @@ declare namespace sap {
        *
        * Only works when selectionBehavior is "SERIES"
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       addSelectedSeries(
@@ -2084,6 +2144,7 @@ declare namespace sap {
        * Event fires when certain data point(s) is(are) deselected, data context of deselected item(s) would be
        * passed in
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachDeselectData(
@@ -2110,6 +2171,7 @@ declare namespace sap {
        * Event fires when certain data point(s) is(are) deselected, data context of deselected item(s) would be
        * passed in
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachDeselectData(
@@ -2130,6 +2192,7 @@ declare namespace sap {
        *
        * fired after a drill-down operation
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachDrilledDown(
@@ -2155,6 +2218,7 @@ declare namespace sap {
        *
        * fired after a drill-down operation
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachDrilledDown(
@@ -2175,6 +2239,7 @@ declare namespace sap {
        *
        * fired after a drill-up operation
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachDrilledUp(
@@ -2200,6 +2265,7 @@ declare namespace sap {
        *
        * fired after a drill-up operation
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachDrilledUp(
@@ -2222,6 +2288,7 @@ declare namespace sap {
        * Event fires when drill stack changed. API that relies on drill stack like {@link #drillDown}, {@link #drillUp }
        * shall be called in this event or after chart is rendered
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachDrillStackChanged(
@@ -2249,6 +2316,7 @@ declare namespace sap {
        * Event fires when drill stack changed. API that relies on drill stack like {@link #drillDown}, {@link #drillUp }
        * shall be called in this event or after chart is rendered
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachDrillStackChanged(
@@ -2270,6 +2338,7 @@ declare namespace sap {
        *
        * Event fires when the rendering ends.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachRenderComplete(
@@ -2296,6 +2365,7 @@ declare namespace sap {
        *
        * Event fires when the rendering ends.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachRenderComplete(
@@ -2317,6 +2387,7 @@ declare namespace sap {
        * Event fires when certain data point(s) is(are) selected, data context of selected item(s) would be passed
        * in.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachSelectData(
@@ -2343,6 +2414,7 @@ declare namespace sap {
        * Event fires when certain data point(s) is(are) selected, data context of selected item(s) would be passed
        * in.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachSelectData(
@@ -2364,6 +2436,7 @@ declare namespace sap {
        *
        * Event fires when fixed scale is turned off by adding or removing dimension
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachValueAxisFixedScaleTurnedOff(
@@ -2390,6 +2463,7 @@ declare namespace sap {
        *
        * Event fires when fixed scale is turned off by adding or removing dimension
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       attachValueAxisFixedScaleTurnedOff(
@@ -2411,6 +2485,7 @@ declare namespace sap {
        * **NOTE:** If the {@link sap.ui.model.odata.v4.ODataListBinding list binding} is suspended, data related
        * requests in Chart will be impacted, and the corresponding operations might not work as expected.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       bindData(
@@ -2428,12 +2503,14 @@ declare namespace sap {
        * Destroys all the dimensions in the aggregation dimensions, only works when the property isAnalytical
        * is true.
        *
+       *
        * @returns Reference to this in order to allow method chaining
        */
       destroyDimensions(): this;
       /**
        * Destroys all the measures in the aggregation {@link #getMeasures measures}.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       destroyMeasures(): this;
@@ -2442,6 +2519,7 @@ declare namespace sap {
        *
        * The passed function and listener object must match the ones used for event registration.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       detachDeselectData(
@@ -2459,6 +2537,7 @@ declare namespace sap {
        *
        * The passed function and listener object must match the ones used for event registration.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       detachDrilledDown(
@@ -2476,6 +2555,7 @@ declare namespace sap {
        *
        * The passed function and listener object must match the ones used for event registration.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       detachDrilledUp(
@@ -2494,6 +2574,7 @@ declare namespace sap {
        *
        * The passed function and listener object must match the ones used for event registration.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       detachDrillStackChanged(
@@ -2512,6 +2593,7 @@ declare namespace sap {
        *
        * The passed function and listener object must match the ones used for event registration.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       detachRenderComplete(
@@ -2529,6 +2611,7 @@ declare namespace sap {
        *
        * The passed function and listener object must match the ones used for event registration.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       detachSelectData(
@@ -2547,6 +2630,7 @@ declare namespace sap {
        *
        * The passed function and listener object must match the ones used for event registration.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       detachValueAxisFixedScaleTurnedOff(
@@ -2590,6 +2674,7 @@ declare namespace sap {
        * Export the current chart as SVG String. The chart is ready to be exported to SVG ONLY after the initialization
        * is finished. Any attempt to export to SVG before that will result in an empty SVG string.
        *
+       *
        * @returns the SVG string of the current viz or empty svg if error occurs.
        */
       exportToSVGString(
@@ -2608,10 +2693,10 @@ declare namespace sap {
         option?: Object
       ): string;
       /**
-       * @ui5-protected Do not call from applications (only from related classes in the framework)
-       *
        * Fires event {@link #event:deselectData deselectData} to attached listeners.
        *
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       fireDeselectData(
@@ -2621,10 +2706,10 @@ declare namespace sap {
         mParameters?: object
       ): this;
       /**
-       * @ui5-protected Do not call from applications (only from related classes in the framework)
-       *
        * Fires event {@link #event:drilledDown drilledDown} to attached listeners.
        *
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       fireDrilledDown(
@@ -2634,10 +2719,10 @@ declare namespace sap {
         mParameters?: sap.chart.Chart$DrilledDownEventParameters
       ): this;
       /**
-       * @ui5-protected Do not call from applications (only from related classes in the framework)
-       *
        * Fires event {@link #event:drilledUp drilledUp} to attached listeners.
        *
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       fireDrilledUp(
@@ -2647,10 +2732,10 @@ declare namespace sap {
         mParameters?: sap.chart.Chart$DrilledUpEventParameters
       ): this;
       /**
-       * @ui5-protected Do not call from applications (only from related classes in the framework)
-       *
        * Fires event {@link #event:drillStackChanged drillStackChanged} to attached listeners.
        *
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       fireDrillStackChanged(
@@ -2660,10 +2745,10 @@ declare namespace sap {
         mParameters?: object
       ): this;
       /**
-       * @ui5-protected Do not call from applications (only from related classes in the framework)
-       *
        * Fires event {@link #event:renderComplete renderComplete} to attached listeners.
        *
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       fireRenderComplete(
@@ -2673,10 +2758,10 @@ declare namespace sap {
         mParameters?: object
       ): this;
       /**
-       * @ui5-protected Do not call from applications (only from related classes in the framework)
-       *
        * Fires event {@link #event:selectData selectData} to attached listeners.
        *
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       fireSelectData(
@@ -2686,10 +2771,10 @@ declare namespace sap {
         mParameters?: object
       ): this;
       /**
-       * @ui5-protected Do not call from applications (only from related classes in the framework)
-       *
        * Fires event {@link #event:valueAxisFixedScaleTurnedOff valueAxisFixedScaleTurnedOff} to attached listeners.
        *
+       * @ui5-protected Do not call from applications (only from related classes in the framework)
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       fireValueAxisFixedScaleTurnedOff(
@@ -2733,6 +2818,7 @@ declare namespace sap {
        * ```
        *
        *
+       *
        * @returns Value of property `activeColoring`
        */
       getActiveColoring(): object;
@@ -2761,6 +2847,7 @@ declare namespace sap {
        * ```
        *
        *
+       *
        * @returns chart types and errors for unavailable chart types, grouped by availability
        */
       getAvailableChartTypes(): object;
@@ -2771,6 +2858,7 @@ declare namespace sap {
        *
        * Default value is `"bar"`.
        *
+       *
        * @returns Value of property `chartType`
        */
       getChartType(): string;
@@ -2803,6 +2891,7 @@ declare namespace sap {
        *  {@link sap.chart.ColoringType.Emphasis}
        *  for detailed usage
        *
+       *
        * @returns Value of property `colorings`
        */
       getColorings(): object;
@@ -2811,6 +2900,7 @@ declare namespace sap {
        *
        * Chart custom messages.
        *
+       *
        * @returns Value of property `customMessages`
        */
       getCustomMessages(): object;
@@ -2822,6 +2912,7 @@ declare namespace sap {
       /**
        * Return Dimension with the given name.
        *
+       *
        * @returns Dimension of the specified name.
        */
       getDimensionByName(
@@ -2842,6 +2933,7 @@ declare namespace sap {
        * NOTE: If {@link sap.chart.data.HierarchyDimension} is used when calling {@link #setVisibleDimensions},
        * drill stack could not be determined synchronously. Listen to `drillStackChanged` event instead.
        *
+       *
        * @returns array of drill state objects
        */
       getDrillStack(): Object[];
@@ -2863,6 +2955,7 @@ declare namespace sap {
        *
        * Default value is `false`.
        *
+       *
        * @returns Value of property `enablePagination`
        */
       getEnablePagination(): boolean;
@@ -2873,6 +2966,7 @@ declare namespace sap {
        *
        * Default value is `false`.
        *
+       *
        * @returns Value of property `enableScalingFactor`
        */
       getEnableScalingFactor(): boolean;
@@ -2883,6 +2977,7 @@ declare namespace sap {
        *
        * Default value is `false`.
        *
+       *
        * @returns Value of property `enableStableColor`
        */
       getEnableStableColor(): boolean;
@@ -2894,6 +2989,7 @@ declare namespace sap {
        *
        * Default value is `true`.
        *
+       *
        * @returns Value of property `hideSharedInformation`
        */
       getHideSharedInformation(): boolean;
@@ -2907,6 +3003,7 @@ declare namespace sap {
        *
        * Default value is `[]`.
        *
+       *
        * @returns Value of property `inResultDimensions`
        */
       getInResultDimensions(): string[];
@@ -2918,12 +3015,14 @@ declare namespace sap {
        * The property isAnalytical will programmatically set according to data source. When the data source has
        * an aggregated entity set, isAnalytical is true, otherwise it's false.
        *
+       *
        * @returns Value of property isAnalytical
        */
       getIsAnalytical(): boolean;
       /**
        * Return Measure with the given name.
        *
+       *
        * @returns Measure of the specified name.
        */
       getMeasureByName(
@@ -2941,6 +3040,7 @@ declare namespace sap {
       /**
        * return the scaling factor. Or return null when scaling factor is disable.
        *
+       *
        * @returns A scaling factor object or null
        */
       getScalingFactor(): object;
@@ -2963,6 +3063,7 @@ declare namespace sap {
        *
        * Return 0 and empty list if selectionBehavior is not "CATEGORY"
        *
+       *
        * @returns a total number of selected data points, and an array of category objects for selected categories.
        */
       getSelectedCategories(): object;
@@ -2990,6 +3091,7 @@ declare namespace sap {
        *
        * Only works when selectionBehavior is "DATAPOINT"
        *
+       *
        * @returns a total number of selected data points, and an array of datapoint objects.
        */
       getSelectedDataPoints(): object;
@@ -3012,6 +3114,7 @@ declare namespace sap {
        *
        * Return 0 and empty list if selectionBehavior is not "SERIES"
        *
+       *
        * @returns object containing a total number of selected data points, and an array of series objects for
        * selected series.
        */
@@ -3023,6 +3126,7 @@ declare namespace sap {
        *
        * Default value is `DataPoint`.
        *
+       *
        * @returns Value of property `selectionBehavior`
        */
       getSelectionBehavior(): sap.chart.SelectionBehavior;
@@ -3033,12 +3137,14 @@ declare namespace sap {
        *
        * Default value is `Multi`.
        *
+       *
        * @returns Value of property `selectionMode`
        */
       getSelectionMode(): sap.chart.SelectionMode;
       /**
        * Return all TimeDimensions from current Dimensions.
        *
+       *
        * @returns Dimensions which are instance of TimeDimension.
        */
       getTimeDimensions(): any[];
@@ -3048,6 +3154,7 @@ declare namespace sap {
        * Configuration for initialization to VizControl. This property could only set via settings parameter in
        * Constructor.
        *
+       *
        * @returns Value of property `uiConfig`
        */
       getUiConfig(): object;
@@ -3128,6 +3235,7 @@ declare namespace sap {
        *  {@link sap.chart.ScaleBehavior.FixedScale}
        *  for detailed usage
        *
+       *
        * @returns Value of property `valueAxisScale`
        */
       getValueAxisScale(): object;
@@ -3141,6 +3249,7 @@ declare namespace sap {
        *
        * Default value is `[]`.
        *
+       *
        * @returns Value of property `visibleDimensions`
        */
       getVisibleDimensions(): string[];
@@ -3153,6 +3262,7 @@ declare namespace sap {
        *
        * Default value is `[]`.
        *
+       *
        * @returns Value of property `visibleMeasures`
        */
       getVisibleMeasures(): string[];
@@ -3162,6 +3272,7 @@ declare namespace sap {
        * Refer to chart property documentation for more
        * details.
        *
+       *
        * @returns the Chart properties object
        */
       getVizProperties(): object;
@@ -3171,18 +3282,18 @@ declare namespace sap {
        * Refer to chart property documentation for more
        * details.
        *
+       *
        * @returns an array of scale objects
        */
       getVizScales(): object[];
       /**
        * Get the UID for Chart. It supports other controls to connect to a viz instance.
        *
+       *
        * @returns Chart UID
        */
       getVizUid(): string;
       /**
-       * @since 1.54
-       *
        * Get zoom information.
        *
        * Return the zooming enablement and current zooming level of chart.
@@ -3199,6 +3310,8 @@ declare namespace sap {
        * ```
        *
        *
+       * @since 1.54
+       *
        * @returns The zooming enablement and current zooming level of chart.The zooming level is between 0 and
        * 1, and null when zooming isn't applicable.
        */
@@ -3212,6 +3325,7 @@ declare namespace sap {
        * Checks for the provided `sap.chart.data.Dimension` in the aggregation {@link #getDimensions dimensions}.
        * and returns its index if found or -1 otherwise.
        *
+       *
        * @returns The index of the provided control in the aggregation if found, or -1 otherwise
        */
       indexOfDimension(
@@ -3224,6 +3338,7 @@ declare namespace sap {
        * Checks for the provided `sap.chart.data.Measure` in the aggregation {@link #getMeasures measures}. and
        * returns its index if found or -1 otherwise.
        *
+       *
        * @returns The index of the provided control in the aggregation if found, or -1 otherwise
        */
       indexOfMeasure(
@@ -3240,6 +3355,7 @@ declare namespace sap {
       /**
        * Inserts a dimension into the aggregation {@link #getDimensions dimensions}.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       insertDimension(
@@ -3257,6 +3373,7 @@ declare namespace sap {
       /**
        * Inserts a measure into the aggregation {@link #getMeasures measures}.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       insertMeasure(
@@ -3282,6 +3399,7 @@ declare namespace sap {
        *
        * Additionally, it unregisters them from the hosting UIArea.
        *
+       *
        * @returns An array of the removed elements (might be empty)
        */
       removeAllDimensions(): sap.chart.data.Dimension[];
@@ -3290,6 +3408,7 @@ declare namespace sap {
        *
        * Additionally, it unregisters them from the hosting UIArea.
        *
+       *
        * @returns An array of the removed elements (might be empty)
        */
       removeAllMeasures(): sap.chart.data.Measure[];
@@ -3302,6 +3421,7 @@ declare namespace sap {
        * Removes a dimension from the aggregation dimensions, remove a visible dimension is unsupported when the
        * property isAnalytical is false.
        *
+       *
        * @returns The removed dimension or null
        */
       removeDimension(
@@ -3313,6 +3433,7 @@ declare namespace sap {
       /**
        * Removes a measure from the aggregation {@link #getMeasures measures}.
        *
+       *
        * @returns The removed measure or `null`
        */
       removeMeasure(
@@ -3340,6 +3461,7 @@ declare namespace sap {
        *
        * Only works when selectionBehavior is "CATEGORY"
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       removeSelectedCategories(
@@ -3364,6 +3486,7 @@ declare namespace sap {
        *
        * Only works when selectionBehavior is "DATAPOINT"
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       removeSelectedDataPoints(
@@ -3391,6 +3514,7 @@ declare namespace sap {
        *
        * Only works when selectionBehavior is "SERIES"
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       removeSelectedSeries(
@@ -3402,6 +3526,7 @@ declare namespace sap {
       /**
        * Reset to visible layout.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       resetLayout(): this;
@@ -3442,6 +3567,7 @@ declare namespace sap {
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setActiveColoring(
@@ -3459,6 +3585,7 @@ declare namespace sap {
        *
        * Default value is `"bar"`.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setChartType(
@@ -3498,6 +3625,7 @@ declare namespace sap {
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setColorings(
@@ -3553,6 +3681,7 @@ declare namespace sap {
        *
        * Default value is false.
        *
+       *
        * @returns Reference to this in order to allow method chaining
        */
       setEnablePagination(
@@ -3570,6 +3699,7 @@ declare namespace sap {
        *
        * Default value is `false`.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setEnableScalingFactor(
@@ -3587,6 +3717,7 @@ declare namespace sap {
        *
        * Default value is `false`.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setEnableStableColor(
@@ -3605,6 +3736,7 @@ declare namespace sap {
        *
        * Default value is `true`.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setHideSharedInformation(
@@ -3625,6 +3757,7 @@ declare namespace sap {
        *
        * Default value is `[]`.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setInResultDimensions(
@@ -3656,6 +3789,7 @@ declare namespace sap {
        *
        * Only works when selectionBehavior is "CATEGORY"
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setSelectedCategories(
@@ -3680,6 +3814,7 @@ declare namespace sap {
        *
        * Only works when selectionBehavior is "DATAPOINT"
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setSelectedDataPoints(
@@ -3707,6 +3842,7 @@ declare namespace sap {
        *
        * Only works when selectionBehavior is "SERIES"
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setSelectedSeries(
@@ -3724,6 +3860,7 @@ declare namespace sap {
        *
        * Default value is `DataPoint`.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setSelectionBehavior(
@@ -3741,6 +3878,7 @@ declare namespace sap {
        *
        * Default value is `Multi`.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setSelectionMode(
@@ -3853,6 +3991,7 @@ declare namespace sap {
        *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setValueAxisScale(
@@ -3873,6 +4012,7 @@ declare namespace sap {
        *
        * Default value is [].
        *
+       *
        * @returns Reference to this in order to allow method chaining
        */
       setVisibleDimensions(
@@ -3892,6 +4032,7 @@ declare namespace sap {
        *
        * Default value is `[]`.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       setVisibleMeasures(
@@ -3931,6 +4072,7 @@ declare namespace sap {
       /**
        * Unbinds aggregation {@link #getData data} from model data.
        *
+       *
        * @returns Reference to `this` in order to allow method chaining
        */
       unbindData(): this;
@@ -4702,6 +4844,8 @@ declare namespace sap {
     }
     /**
      * Enumeration for supported message types in analytical chart.
+     *
+     * This enum is part of the 'sap/chart/library' module export and must be accessed by the property 'MessageId'.
      */
     enum MessageId {
       /**
@@ -4728,6 +4872,8 @@ declare namespace sap {
     }
     /**
      * Enumeration for supported selection behavior in analytical chart
+     *
+     * This enum is part of the 'sap/chart/library' module export and must be accessed by the property 'SelectionBehavior'.
      */
     enum SelectionBehavior {
       /**
@@ -4745,6 +4891,8 @@ declare namespace sap {
     }
     /**
      * Enumeration for supported selection mode in analytical chart
+     *
+     * This enum is part of the 'sap/chart/library' module export and must be accessed by the property 'SelectionMode'.
      */
     enum SelectionMode {
       /**