@openui5/ts-types 1.140.0 → 1.141.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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare module "sap/ui/mdc/AggregationBaseDelegate" {
4
4
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -1830,9 +1830,9 @@ declare module "sap/ui/mdc/odata/v4/TableDelegate" {
1830
1830
  * If an update is not possible, it rebinds the table.
1831
1831
  *
1832
1832
  * Compares the current and previous state of the table to detect whether rebinding is necessary. The diffing
1833
- * is done for the sorters, filters, aggregation, parameters. Other {@link sap.ui.base.ManagedObject.AggregationBindingInfo binding info }
1834
- * keys, such as `path`, `events`, or `model`, must be provided in `updateBindingInfo`, and those keys must
1835
- * not be changed conditionally.
1833
+ * is done for the sorters, filters, aggregation, parameters, and the path of the binding. Other {@link sap.ui.base.ManagedObject.AggregationBindingInfo binding info }
1834
+ * keys, such as `events` or `model`, must be provided in `updateBindingInfo`, and those keys must not be
1835
+ * changed conditionally.
1836
1836
  *
1837
1837
  * **Note:** To remove a binding info parameter, the value must be set to `undefined` in `updateBindingInfo`.
1838
1838
  * For more information, see {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters}.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -640,6 +640,10 @@ declare namespace sap {
640
640
  *
641
641
  * For details about data aggregation, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}.
642
642
  *
643
+ * In combination with the {@link sap.ui.table.Table Table} control, this plugin offers a UI for OData V4
644
+ * that is similar to the one the {@link sap.ui.table.AnalyticalTable AnalyticalTable} offers for OData
645
+ * V2.
646
+ *
643
647
  * @since 1.140
644
648
  */
645
649
  class ODataV4Aggregation extends sap.ui.core.Element {
@@ -775,6 +779,9 @@ declare namespace sap {
775
779
  *
776
780
  * For details about hierarchies, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}.
777
781
  *
782
+ * In combination with the {@link sap.ui.table.Table Table} control, this plugin offers a UI for OData V4
783
+ * that is similar to the one the {@link sap.ui.table.TreeTable TreeTable} offers for other models.
784
+ *
778
785
  * @since 1.140
779
786
  */
780
787
  class ODataV4Hierarchy extends sap.ui.core.Element {
@@ -4383,9 +4390,11 @@ declare namespace sap {
4383
4390
  static getMetadata(): sap.ui.core.ElementMetadata;
4384
4391
  }
4385
4392
  /**
4386
- * Table that handles analytical OData back-end scenarios. The `AnalyticalTable` only works with {@link sap.ui.model.analytics.AnalyticalBinding AnalyticalBinding }
4393
+ * Table that handles analytical OData V2 back-end scenarios. The `AnalyticalTable` only works with {@link sap.ui.model.analytics.AnalyticalBinding AnalyticalBinding }
4387
4394
  * and correctly annotated OData services. Please check out the functionality of analytical binding and
4388
- * the SAP Annotations for OData Version 2.0 documentation for further details.
4395
+ * the SAP Annotations for OData Version 2.0 documentation for further details. For an analytical-table-like
4396
+ * behavior with OData V4 services, use the {@link sap.ui.table.Table Table} control with the {@link sap.ui.table.plugins.ODataV4Aggregation ODataV4Aggregation }
4397
+ * plugin.
4389
4398
  */
4390
4399
  class AnalyticalTable extends sap.ui.table.Table {
4391
4400
  /**
@@ -4396,6 +4405,7 @@ declare namespace sap {
4396
4405
  * of the syntax of the settings object.
4397
4406
  * See:
4398
4407
  * https://github.com/SAP/odata-vocabularies/blob/main/docs/v2-annotations.md
4408
+ * {@link https://ui5.sap.com/#/topic/148892ff9aea4a18b912829791e38f3e Tables: Which One Should I Choose?}
4399
4409
  * {@link https://ui5.sap.com/#/topic/08197fa68e4f479cbe30f639cc1cd22c sap.ui.table}
4400
4410
  * {@link fiori:/analytical-table-alv/ Analytical Table}
4401
4411
  */
@@ -4413,6 +4423,7 @@ declare namespace sap {
4413
4423
  * of the syntax of the settings object.
4414
4424
  * See:
4415
4425
  * https://github.com/SAP/odata-vocabularies/blob/main/docs/v2-annotations.md
4426
+ * {@link https://ui5.sap.com/#/topic/148892ff9aea4a18b912829791e38f3e Tables: Which One Should I Choose?}
4416
4427
  * {@link https://ui5.sap.com/#/topic/08197fa68e4f479cbe30f639cc1cd22c sap.ui.table}
4417
4428
  * {@link fiori:/analytical-table-alv/ Analytical Table}
4418
4429
  */
@@ -10989,7 +11000,10 @@ declare namespace sap {
10989
11000
  ): this;
10990
11001
  }
10991
11002
  /**
10992
- * The TreeTable control provides a comprehensive set of features to display hierarchical data.
11003
+ * The TreeTable control provides a comprehensive set of features to display hierarchical data. The control
11004
+ * can be used in combination with {@link sap.ui.model.json.JSONModel JSONModel} and {@link sap.ui.model.odata.v2.ODataModel ODataModel V2}.
11005
+ * For a tree-table-like behavior with OData V4 services, use the {@link sap.ui.table.Table Table} control
11006
+ * with the {@link sap.ui.table.plugins.ODataV4Hierarchy ODataV4Hierarchy} plugin.
10993
11007
  */
10994
11008
  class TreeTable extends sap.ui.table.Table {
10995
11009
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -6158,6 +6158,12 @@ declare namespace sap {
6158
6158
  * - Do not use interactive controls as content, as they may trigger unwanted selection of the appointment
6159
6159
  * and may lead to unpredictable results.
6160
6160
  *
6161
+ * **Note:** When using the `customContent` aggregation, it is the application developer's responsibility
6162
+ * to add appropriate labels to the `ariaLabelledBy` association to provide accessible information about
6163
+ * this appointment as the standard properties (`title`, `text`, `description`, and `icon`) are ignored,
6164
+ * which means screen readers will have no information about the appointment unless proper ARIA labeling
6165
+ * is implemented.
6166
+ *
6161
6167
  * @since 1.93.0
6162
6168
  */
6163
6169
  customContent?:
@@ -6165,6 +6171,11 @@ declare namespace sap {
6165
6171
  | sap.ui.core.Control
6166
6172
  | sap.ui.base.ManagedObject.AggregationBindingInfo
6167
6173
  | `{${string}}`;
6174
+
6175
+ /**
6176
+ * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledBy).
6177
+ */
6178
+ ariaLabelledBy?: Array<sap.ui.core.Control | string>;
6168
6179
  }
6169
6180
 
6170
6181
  /**
@@ -10145,6 +10156,18 @@ declare namespace sap {
10145
10156
  * @returns Metadata object describing this class
10146
10157
  */
10147
10158
  static getMetadata(): sap.ui.core.ElementMetadata;
10159
+ /**
10160
+ * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}.
10161
+ *
10162
+ *
10163
+ * @returns Reference to `this` in order to allow method chaining
10164
+ */
10165
+ addAriaLabelledBy(
10166
+ /**
10167
+ * The ariaLabelledBy to add; if empty, nothing is inserted
10168
+ */
10169
+ vAriaLabelledBy: sap.ui.core.ID | sap.ui.core.Control
10170
+ ): this;
10148
10171
  /**
10149
10172
  * Adds some customContent to the aggregation {@link #getCustomContent customContent}.
10150
10173
  *
@@ -10166,6 +10189,10 @@ declare namespace sap {
10166
10189
  * @returns Reference to `this` in order to allow method chaining
10167
10190
  */
10168
10191
  destroyCustomContent(): this;
10192
+ /**
10193
+ * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}.
10194
+ */
10195
+ getAriaLabelledBy(): sap.ui.core.ID[];
10169
10196
  /**
10170
10197
  * Gets current value of property {@link #getColor color}.
10171
10198
  *
@@ -10191,6 +10218,12 @@ declare namespace sap {
10191
10218
  * - Do not use interactive controls as content, as they may trigger unwanted selection of the appointment
10192
10219
  * and may lead to unpredictable results.
10193
10220
  *
10221
+ * **Note:** When using the `customContent` aggregation, it is the application developer's responsibility
10222
+ * to add appropriate labels to the `ariaLabelledBy` association to provide accessible information about
10223
+ * this appointment as the standard properties (`title`, `text`, `description`, and `icon`) are ignored,
10224
+ * which means screen readers will have no information about the appointment unless proper ARIA labeling
10225
+ * is implemented.
10226
+ *
10194
10227
  * @since 1.93.0
10195
10228
  */
10196
10229
  getCustomContent(): sap.ui.core.Control[];
@@ -10297,6 +10330,13 @@ declare namespace sap {
10297
10330
  */
10298
10331
  iIndex: int
10299
10332
  ): this;
10333
+ /**
10334
+ * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}.
10335
+ *
10336
+ *
10337
+ * @returns An array of the removed elements (might be empty)
10338
+ */
10339
+ removeAllAriaLabelledBy(): sap.ui.core.ID[];
10300
10340
  /**
10301
10341
  * Removes all the controls from the aggregation {@link #getCustomContent customContent}.
10302
10342
  *
@@ -10307,6 +10347,18 @@ declare namespace sap {
10307
10347
  * @returns An array of the removed elements (might be empty)
10308
10348
  */
10309
10349
  removeAllCustomContent(): sap.ui.core.Control[];
10350
+ /**
10351
+ * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}.
10352
+ *
10353
+ *
10354
+ * @returns The removed ariaLabelledBy or `null`
10355
+ */
10356
+ removeAriaLabelledBy(
10357
+ /**
10358
+ * The ariaLabelledBy to be removed or its index or ID
10359
+ */
10360
+ vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control
10361
+ ): sap.ui.core.ID | null;
10310
10362
  /**
10311
10363
  * Removes a customContent from the aggregation {@link #getCustomContent customContent}.
10312
10364
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.140.0
1
+ // For Library Version: 1.141.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**