@sapui5/ts-types 1.97.2 → 1.100.0

package/types/sap.viz.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.1
+// For Library Version: 1.100.0
 
 declare namespace sap {
   /**
@@ -21,6 +21,7 @@ declare namespace sap {
              * Example:
              * ```javascript
              *
+             * // Format required from "sap/viz/ui5/api/env/Format"
              * var customerFormatter = {
              *     format : function(value, pattern) {
              *         // add your codes here to convert number value to formatted string
@@ -28,10 +29,10 @@ declare namespace sap {
              *         return formattedString;
              *     }
              * };
-             * sap.viz.ui5.api.env.Format.numericFormatter(customerFormatter);
+             * Format.numericFormatter(customerFormatter);
              * ```
              */
-            numericFormatter(formatter: Function): sap.viz.ui5.api.env.Format;
+            numericFormatter(formatter: Function): any;
           }
           const Format: Format;
         }
@@ -740,7 +741,7 @@ declare namespace sap {
            */
           constructor(
             /**
-             * id for the new control, generated automatically if no id is given
+             * ID for the new control, generated automatically if no ID is given
              */
             sId?: string,
             /**
@@ -779,23 +780,16 @@ declare namespace sap {
            */
           close(): void;
           /**
-           * Connect chart Popover with VizFrame. Chart Popover is only supported for VizFrame with 'fiori' type.
-           * It must be called by application.
-           *
-           * Example:
-           * ```javascript
+           * Connect chart Popover with VizFrame.
            *
-           * var vizFrame = new sap.viz.ui5.controls.VizFrame({
-           * 	'vizType' : 'bar',
-           *  'uiConfig' : {
-           *     'applicationSet': 'fiori'
-           *   }
-           * });
-           * var vizPopover = new sap.viz.ui5.controls.Popover({});
-           * vizPopover.connect(vizFrame.getVizUid());
-           * ```
+           * Chart Popover is only supported for VizFrame with type 'fiori'. This method must be called by application.
            */
-          connect(uid: string): void;
+          connect(
+            /**
+             * Unique ID of the VizFrame to connect this Popover with
+             */
+            uid: string
+          ): void;
           /**
            * Gets current value of property {@link #getActionItems actionItems}.
            *
@@ -1139,23 +1133,33 @@ declare namespace sap {
             oListener?: object
           ): this;
           /**
-           * Export the current viz as SVG String. The viz 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.
+           * Exports the current viz as an SVG String.
+           *
+           * The viz 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.
            */
           exportToSVGString(
             /**
-             *
-             * ```javascript
-             *
-             * {
-             *     width: Number - the exported svg will be scaled to the specific width.
-             *     height: Number - the exported svg will be scaled to the specific height.
-             *     hideTitleLegend: Boolean - flag to indicate if the exported svg includes the original title and legend.
-             *     hideAxis: Boolean - flag to indicate if the exported svg includes the original axis.
-             * }
-             * ```
+             * Options for the export
              */
-            option?: Object
+            option?: {
+              /**
+               * the exported SVG will be scaled to the specific width
+               */
+              width?: int;
+              /**
+               * the exported SVG will be scaled to the specific height
+               */
+              height?: int;
+              /**
+               * flag to indicate if the exported SVG includes the original title and legend
+               */
+              hideTitleLegend?: boolean;
+              /**
+               * flag to indicate if the exported SVG includes the original axis
+               */
+              hideAxis?: boolean;
+            }
           ): string;
           /**
            * Fires event {@link #event:deselectData deselectData} to attached listeners.
@@ -1250,7 +1254,7 @@ declare namespace sap {
            */
           getVizType(): string;
           /**
-           * Uid for viz frame. It supports other controls to connect to a viz instance.
+           * Uid for this viz frame. It supports other controls to connect to a viz instance.
            */
           getVizUid(): string;
           /**
@@ -1321,92 +1325,31 @@ declare namespace sap {
             /**
              * Set legend visibility.
              */
-            bLegendVisible: boolean
-          ): object;
+            visibility: boolean
+          ): this;
           /**
            * Setter for property uiConfig. uiConfig could only set via settings parameter of constructor.
            *
            * uiConfig from base type could config the instance. Supported uiConfig keyword: applicationSet, showErrorMessage
-           *
-           * Example:
-           *
-           *
-           * ```javascript
-           *
-           * var vizFrame = new sap.viz.ui5.controls.VizFrame({
-           *  'vizType' : 'bar',
-           *  'uiConfig' : {
-           *      'applicationSet' : 'fiori',
-           *      'showErrorMessage' : true
-           *  }
-           * });
-           * ```
            */
           setUiConfig(oUiConfig: object): this;
-          /**
-           * Sets a new value for property {@link #getVizCustomizations vizCustomizations}.
-           *
-           * Chart customizations property, aim to customize existing (build-in) charts to meet specific LoB requirements.
-           * Currently, supported chart type : column, dual_column, bar, dual_bar, stacked_column, stacked_bar, 100_stacked_bar,
-           * 100_stacked_column, 100_dual_stacked_bar, 100_dual_stacked_column, dual_stacked_bar, dual_stacked_column,
-           * line, horizontal_line, dual_line, dual_horizontal_line, combination, horizontal_combination, stacked_combination,
-           * horizontal_stacked_combination, dual_stacked_combination, dual_horizontal_stacked_combination, scatter,
-           * bubble.
-           *
-           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
-           */
-          setVizCustomizations(
-            /**
-             * New value for property `vizCustomizations`
-             */
-            oVizCustomizations?: object
-          ): this;
           /**
            * Properties for viz frame.
-           *
-           * Example:
-           *
-           *
-           * ```javascript
-           *
-           *  var vizFrame = new sap.viz.ui5.controls.VizFrame(...);
-           *  var properties = {
-           *      'legend' : { 'visible'; : true }
-           * };
-           * vizFrame.setVizProperties(properties);
-           * ```
            */
           setVizProperties(oVizProperties: object): this;
           /**
            * Scales for VizFrame.
-           *
-           * Example:
-           *
-           *
-           * ```javascript
-           *
-           * var vizFrame = new sap.viz.ui5.controls.VizFrame(...);
-           * var scales = [{
-           *      'feed': 'color',
-           *      'palette': ['#ff0000']
-           * }];
-           * var vizScalesOption = {replace: true};
-           * vizFrame.setVizScales(scales, vizScalesOption);
-           * ```
            */
           setVizScales(
             oVizScales: object,
-            /**
-             *
-             * ```javascript
-             *
-             * {
-             *     replace: Boolean - replace scales or not. When oVizScalesOption.replace is true,
-             *                        replace existing scales with the input scales.
-             * }
-             * ```
-             */
-            oVizScalesOption?: object
+
+            oVizScalesOption?: {
+              /**
+               * replace scales or not. When oVizScalesOption.replace is true, replace existing scales with the input
+               * scales.
+               */
+              replace?: boolean;
+            }
           ): this;
           /**
            * Setter for property vizType. vizType could only set via settings parameter in Constructor. Do not set
@@ -1420,7 +1363,8 @@ declare namespace sap {
            * Example:
            * ```javascript
            *
-           * var vizFrame = new sap.viz.ui5.controls.VizFrame({
+           * // VizFrame required from "sap/viz/ui5/controls/VizFrame"
+           * var vizFrame = new VizFrame({
            *  'vizType' : 'bar'
            * });
            * ```
@@ -1431,67 +1375,15 @@ declare namespace sap {
            * Example:
            * ```javascript
            *
-           * var vizFrame = new sap.viz.ui5.controls.VizFrame({
+           * // VizFrame required from "sap/viz/ui5/controls/VizFrame"
+           * var vizFrame = new VizFrame({
            *  'vizType' : 'myextension'
            * });
            * ```
            */
           setVizType(sVizType: string): this;
           /**
-           * Selections for viz frame. Example:
-           *
-           *
-           * ```javascript
-           *
-           *  var vizFrame = new sap.viz.ui5.controls.VizFrame(...);
-           *  //vizSelection for set
-           *  var points = [{
-           *      data : {
-           *          "Country" : "China",
-           *          "Year" : "2001",
-           *          "Product" : "Car",
-           *          "Profit" : 25
-           *      }}, {
-           *      data : {
-           *          "Country" : "China",
-           *          "Year" : "2001",
-           *          "Product" : "Trunk",
-           *          "Profit" : 34
-           *      }}];
-           *  var action = {
-           *      clearSelection : true
-           *  };
-           * vizFrame.vizSelection(points, action);
-           * //vizSelection for get and return result
-           * var result = vizFrame.vizSelection();
-           * result = [{
-           *          data : {
-           *              "Country" : "China",
-           *              "Year" : "2001",
-           *              "Product" : "Car",
-           *              "Profit" : 25
-           *          },
-           *          unit : {
-           *              "Profit" : "$"
-           *          },
-           *          dataName : {
-           *              "Profit" : "Actual"
-           *          }
-           *       }, {
-           *          data : {
-           *              "Country" : "China",
-           *              "Year" : "2001",
-           *              "Product" : "Trunk",
-           *              "Profit" : 34
-           *          },
-           *          unit : {
-           *              "Profit" : "$"
-           *          },
-           *          dataName : {
-           *              "Profit" : "Actual"
-           *          }
-           *      }]
-           * ```
+           * Selections for viz frame.
            */
           vizSelection(
             /**
@@ -1502,43 +1394,11 @@ declare namespace sap {
              * whether to clear previous selection, by default the selection will be incremental selection
              */
             oAction: object
-          ): sap.viz.ui5.controls.VizFrame;
+          ): this;
           /**
            * Update viz frame according to a JSON object, it can update css, properties, feeds and data model.
            *
            * VizFrame instance has to be placed at its corresponding parent at first to make this API work.
-           *
-           * Example:
-           *
-           *
-           * ```javascript
-           *
-           * var vizFrame = new sap.viz.ui5.controls.VizFrame(...);
-           * var data = new  sap.viz.ui5.data.FlattenedDataset(...);
-           * var properties = {
-           *     'legend' : {'visible' : true},
-           * };
-           * var scales = [{
-           *      'feed': 'color',
-           *      'palette': ['#ff0000']
-           * }];
-           * var customizations = {id:"sap.viz.custom",customOverlayProperties: {}};
-           * var FeedItem = sap.viz.ui5.controls.common.feeds.FeedItem;
-           * var feeds = [
-           *     new FeedItem({'uid' : 'primaryValues',
-           *                   'type' : 'Measure',
-           *                   'values' : []}),
-           *     new FeedItem({'uid' : 'regionColor',
-           *                   'type' : 'Dimension',
-           *                   'values' : []})];
-           * vizFrame.vizUpdate({
-           *               'data' : data,
-           *               'properties' : properties,
-           *               'scales' : scales,
-           *               'customizations' : customizations,
-           *               'feeds' : feeds
-           *           });
-           * ```
            */
           vizUpdate(
             /**
@@ -1548,19 +1408,12 @@ declare namespace sap {
           ): void;
           /**
            * Zoom the chart plot.
-           *
-           * Example:
-           * ```javascript
-           *
-           *  var vizFrame = new sap.viz.ui5.controls.VizFrame(...);
-           *  vizFrame.zoom({direction: "in"});
-           * ```
            */
           zoom(
             /**
-             * a "direction" attribute with value "in" or "out" indicating zoom to enlarge or shrink respectively
+             * contains a "direction" attribute with value "in" or "out" indicating zoom to enlarge or shrink respectively
              */
-            contains: object
+            cfg: object
           ): void;
         }
         /**
@@ -1849,19 +1702,6 @@ declare namespace sap {
           ): this;
           /**
            * Set start end date of range slider. Supported chart type: timeseries_column, timeseries_line.
-           *
-           * Example:
-           *
-           *
-           * ```javascript
-           *
-           * var vizSlider = new sap.viz.ui5.controls.VizSlider(...);
-           * var range = {
-           *     'start' : timestamp,
-           *     'end' : timestamp
-           * };
-           * vizSlider.setRange(range);
-           * ```
            */
           setRange(
             /**
@@ -2025,19 +1865,6 @@ declare namespace sap {
           /**
            * Connect chart Tooltip with VizFrame. Chart Tooltip is only supported for VizFrame with 'fiori' type.
            * It must be called by application.
-           *
-           * Example:
-           * ```javascript
-           *
-           * var vizFrame = new sap.viz.ui5.controls.VizFrame({
-           *  'vizType' : 'bar',
-           *  'uiConfig' : {
-           *     'applicationSet': 'fiori'
-           *   }
-           * });
-           * var Tooltip = new sap.viz.ui5.controls.VizTooltip({});
-           * Tooltip.connect(vizFrame.getVizUid());
-           * ```
            */
           connect(uid: string): void;
           /**
@@ -3245,6 +3072,40 @@ declare namespace sap {
              */
             oListener?: object
           ): this;
+          /**
+           * @EXPERIMENTAL (since 1.16.6)
+           *
+           * Find the model context for a given 'criteria' into chart data.
+           *
+           * The native sap.viz library provides data objects with the `selectData` event. Applications can call this
+           * method for each data in a selectData event to find the corresponding UI5 model context.
+           *
+           * When the dataset has not been converted into a VIZ dataset yet (e.g. no rendering yet) or when the coordinates
+           * of the path are not within the range of the current dataset, then undefined will be returned.
+           *
+           * Example when use sap.viz.ui5.*:
+           * ```javascript
+           *
+           * selectData: function(oEvent) {
+           *   var aSelectData = oEvent.getParameter("data");
+           *   var oContext = this.getDataset().findContext(aSelectData[0].data[0].ctx.path);
+           * }
+           * ```
+           *  Example when use sap.viz.ui5.controls.VizFrame:
+           * ```javascript
+           *
+           * selectData: function(oEvent) {
+           *   var aSelectData = oEvent.getParameter("data");
+           *   var oContext = this.getDataset().findContext(aSelectData[0].data);
+           * }
+           * ```
+           */
+          findContext(
+            /**
+             * a structure as provided by the sap.viz library
+             */
+            oCriteria: object
+          ): sap.ui.model.Context;
           /**
            * Fires event {@link #event:dataChange dataChange} to attached listeners.
            */
@@ -3444,6 +3305,17 @@ declare namespace sap {
              */
             oContext: any
           ): this;
+          /**
+           * @deprecated (since 1.19) - Please use selection API {@link sap.viz.ui5.core.BaseChart.prototype.selection}.
+           *
+           * Set chart's default selection. This api will do nothing when use VizFrame.
+           */
+          setDefaultSelection(
+            /**
+             * Array of default selection info
+             */
+            selectionInfos: object[]
+          ): void;
           /**
            * Unbinds aggregation {@link #getData data} from model data.
            */
@@ -3851,20 +3723,22 @@ declare namespace sap {
             YEARMONTHDAY = "YearMonthDay",
           }
         }
+
         /**
          * Provides methods set chart formatter for VizFrame.
          */
-        interface ChartFormatter {
+        class ChartFormatter {
+          constructor();
+
           /**
            * Get an instance of ChartFormatter
            */
-          getInstance(): void;
+          static getInstance(): void;
           /**
            * Format the value according to the custom format function
            */
           format(): void;
         }
-        const ChartFormatter: ChartFormatter;
       }
 
       namespace types {

package/types/sap.webanalytics.core.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.100.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

package/types/sap.zen.commons.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.100.0
 
 declare namespace sap {
   namespace zen {

package/types/sap.zen.crosstab.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.100.0
 
 declare namespace sap {
   namespace zen {

package/types/sap.zen.dsh.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.100.0
 
 declare namespace sap {
   namespace zen {
@@ -496,10 +496,6 @@ declare namespace sap {
              */
             sDim: string
           ): this;
-          /**
-           * Resets this data provider to the state after the metadata import
-           */
-          resetToDefault(): void;
           /**
            * Distribute the dimension among the rows and columns
            */
@@ -587,7 +583,7 @@ declare namespace sap {
              * the filter
              */
             oFilter: object
-          ): undefined;
+          ): this;
           /**
            * sets the format property of the dataprovider, this can influence the resultset that is aggregated in
            * the `Grid.Cells` collection. Its main purpose is to influence the visualisation of a `sap.zen.dsh.PivotTable`

package/types/sap.fe.placeholder.d.ts

@@ -1,3 +0,0 @@
-// For Library Version: 1.97.0
-
-declare namespace sap {}

package/types/sap.fe.plugins.d.ts

@@ -1,3 +0,0 @@
-// For Library Version: 1.97.0
-
-declare namespace sap {}

package/types/sap.fe.semantics.d.ts

@@ -1,3 +0,0 @@
-// For Library Version: 1.97.0
-
-declare namespace sap {}

package/types/sap.fe.tools.d.ts

@@ -1,3 +0,0 @@
-// For Library Version: 1.97.0
-
-declare namespace sap {}