@sap/ux-specification 1.108.14 → 1.108.16

package/dist/schemas/v4/ListReportConfig.json

@@ -37,7 +37,7 @@
     },
     "defaultPath": {
       "$ref": "#/definitions/DefaultPathType",
-      "description": "defaultPath can be \"primary\", \"secondary\", or \"both\". If it is \"primary\", SAP Fiori elements loads the app in chart-only view. If it is \"secondary\", SAP Fiori elements loads the app in table-only view. If it is \"both\", SAP Fiori elements loads the app in hybrid view.",
+      "description": "Allows you to set the initial view mode\n\n- primary: This property loads the app in chart-only view.\n- secondary: This property loads the app in table-only view.\n- both: This property loads the app in hybrid view.",
       "artifactType": "Manifest"
     },
     "$schema": {
@@ -103,7 +103,7 @@
               "type": "string"
             }
           ],
-          "description": "Whether the action button should be visible on the screen.",
+          "description": "Allows you to define if the action button is visible on the screen.",
           "artifactType": "Manifest"
         },
         "enabled": {
@@ -119,7 +119,7 @@
               "type": "string"
             }
           ],
-          "description": "Whether the action button should be enabled. Default value is `true`.",
+          "description": "Allows you to define if the action should be enabled. The default value is \"true\".",
           "artifactType": "Manifest"
         }
       },
@@ -161,8 +161,9 @@
       "type": "object",
       "properties": {
         "hideFilterBar": {
-          "description": "To disable the filter bar, set hideFilterBar to true",
+          "description": "Allows you to hide the filter bar.",
           "artifactType": "Manifest",
+          "descriptionSrcURL": "https://ui5.sap.com/sdk/#/topic/4bd7590569c74c61a0124c6e370030f6",
           "type": "boolean"
         },
         "selectionFields": {
@@ -181,12 +182,12 @@
         },
         "initialLayout": {
           "$ref": "#/definitions/InitialLayoutType",
-          "description": "Specifies the default filter mode on initial load. Possible values: \"Visual\" and \"Compact\"",
+          "description": "Allows you to specify the default filter mode on the initial load.",
           "artifactType": "Manifest"
         },
         "layout": {
           "$ref": "#/definitions/LayoutType",
-          "description": "Possible Values: \"Compact\" (if only compact filter is present) and \"CompactVisual\" if both compact and visual filters are present",
+          "description": "Allows you to specify the layout of the filter bar.\n\n- Compact: This setting shows filter fields in compact mode.\n- CompactVisual: This setting shows filter fields in both compact and visual modes.",
           "artifactType": "Manifest"
         }
       },
@@ -197,10 +198,82 @@
       "isViewNode": true,
       "type": "object",
       "additionalProperties": {
-        "type": "object",
-        "properties": {}
+        "anyOf": [
+          {
+            "type": "object",
+            "properties": {}
+          },
+          {
+            "$ref": "#/definitions/CustomFilterField"
+          }
+        ]
       }
     },
+    "CustomFilterField": {
+      "description": "Custom Filter Field",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "label": {
+          "description": "A static or i18n binding string.",
+          "i18nClassification": "COL: Custom filter field label",
+          "type": "string",
+          "artifactType": "Manifest"
+        },
+        "property": {
+          "description": "The full path to the property to be filtered.",
+          "type": "string",
+          "artifactType": "Manifest"
+        },
+        "template": {
+          "description": "The path to the XML template containing the filter control.",
+          "type": "string",
+          "artifactType": "Manifest"
+        },
+        "required": {
+          "description": "If filter field is mandatory, i.e. it requires a value.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "position": {
+          "$ref": "#/definitions/CustomFilterFieldPosition",
+          "description": "Defines the position of the filter field relative to another filter field.",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "label",
+        "property",
+        "template"
+      ]
+    },
+    "CustomFilterFieldPosition": {
+      "type": "object",
+      "properties": {
+        "anchor": {
+          "description": "The key of another filter field is to be used as a placement anchor.",
+          "type": "string",
+          "artifactType": "Manifest"
+        },
+        "placement": {
+          "$ref": "#/definitions/FilterFieldPlacement",
+          "description": "Define the placement, either before or after the anchor filter field.",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "placement"
+      ]
+    },
+    "FilterFieldPlacement": {
+      "enum": [
+        "After",
+        "Before"
+      ],
+      "type": "string"
+    },
     "CompactFilters": {
       "description": "Compact Filters",
       "isViewNode": true,
@@ -225,7 +298,7 @@
       "properties": {
         "availability": {
           "$ref": "#/definitions/Availability",
-          "description": "Defines where the selection field should be shown.\nDefault: it will be shown by default.\nAdaptation: it will initially not be shown in the table but be available via end user adaptation.\nHidden: the selection field is neither available in the table nor in adaptation.",
+          "description": "Defines where the selection field should be shown.\n\n- Default: The filter field is shown by default in the filter bar (both the regular filter fields as well as the corresponding visual filter fields).\n- Adaptation: The filter field is initially not shown but is only available under Adapt Filters.\n- Hidden: The filter field is not visible in the filter bar or within the Adapt Filters dialog.",
           "artifactType": "Manifest"
         },
         "visualFilterValueList": {
@@ -339,12 +412,13 @@
       "type": "object",
       "properties": {
         "navigateToInstance": {
-          "description": "By default, a navigation is automatically triggered after an action execution. If applications want to disable the navigation, they can do so using the manifest setting “navigateToInstance”.",
+          "description": "Allows you to disable the navigation. By default, navigation is automatically triggered after you have performed an action.",
+          "descriptionSrcURL": "https://ui5.sap.com/#/topic/2c65f07f44094012a511d6bd83f50f2d",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "enableAutoScroll": {
-          "description": "The \"enableAutoScroll\" allows you to scroll to the newly created or changed item after execution of an action",
+          "description": "Allows you to scroll to the newly created or changed item after you have performed an action.",
           "type": "boolean",
           "artifactType": "Manifest"
         }
@@ -388,7 +462,7 @@
               "type": "string"
             }
           ],
-          "description": "Whether the action button should be visible on the screen.",
+          "description": "Allows you to define if the action button is visible on the screen.",
           "artifactType": "Manifest"
         },
         "enabled": {
@@ -404,7 +478,7 @@
               "type": "string"
             }
           ],
-          "description": "Whether the action button should be enabled. Default value is `true`.",
+          "description": "Allows you to define if the action should be enabled. The default value is \"true\".",
           "artifactType": "Manifest"
         }
       },
@@ -444,7 +518,7 @@
         },
         "initialLoad": {
           "$ref": "#/definitions/InitialLoadType",
-          "description": "initialLoad defines whether or not the data in the table is automatically loaded.\n- Disabled - Data is never loaded when opening the app without an app state.\n- Enabled - Data is always loaded when opening the app.\n- Auto - Data is only loaded, if initial/preset filters are available (e.g. defined by \"SelectionVariant\" definition, URL parameters or user defaults)."
+          "description": "Allows you to define whether or not the data in the table is automatically loaded\n\n- Auto (default): An initial load of data only occurs if some default filter values have been set in the filter bar\n- Enabled: An initial load of data occurs for the standard variant\n- Disabled: An initial load of data does not occur for the standard variant, and the user has to actively click the Go button."
         },
         "personalization": {
           "$ref": "#/definitions/ViewPersonalizationType",
@@ -463,18 +537,19 @@
         },
         "selectionMode": {
           "$ref": "#/definitions/SelectionMode",
-          "description": "Applications can influence whether the table rows are selectable or not, and whether it allows for single selection or multiple selection. It can take the following values:\n- \"Auto\": This is the default value. In this mode, Fiori Elements first checks if there are any custom actions or IBN buttons in the table toolbar that require a context. If no such buttons are found, then no table selection is allowed in display mode. In edit mode too a selection is not allowed unless there is a Delete button in the table toolbar in which case multiple row selection will be allowed.\n- \"Multi\": This will allow end users to select multiple table records (in both display and edit mode)\n- \"Single\" This will allow end user to select only a single table record (in both display and edit mode)\n- \"None\": This will not allow the end user to select any table record in display mode. This will also be the case in edit mode unless the table has a delete button enabled, in which multiple selection is allowed in delete mode."
+          "description": "Allows you to enable or disable row selection and choose between single or multiple row selection.\n\n- Auto: This type is now deprecated. Choose any of the following modes.\n- Multi (default): This type allows multiple table selections if relevant actions are available in the toolbar. In edit mode, multiple selection is possible with the delete button.\n- Single: This type allows single table selection if relevant actions are available in the toolbar. In edit mode, multiple selection is possible with the Delete button.\n- None: No table selection is possible in display mode. In edit mode, the selection (including multiple row selection) is still possible when the Delete button is available in the table toolbar."
         },
         "selectAll": {
           "description": "The selectAll configuration overrides the selectionLimit and allows the user to select all the items. When set to true, the select all feature is enabled: a checkbox in the table header is displayed which selects all items when clicked.",
           "type": "boolean"
         },
         "selectionLimit": {
-          "description": "With the selectionLimit you can define how many items can be selected at a time,",
+          "description": "You can define how many items can be selected at a time using the selectionLimit.",
           "type": "number"
         },
         "enableExport": {
-          "description": "The exporting of the table to an Excel file is enabled in List Report tables by default. In Object Page, the export to Excel is available by default if the copy/paste feature is also available; otherwise it is disabled.\nTo disable the export in List Report or to enable it in Object Page, use the \"enableExport\" property and set it to false or true.",
+          "description": "By default, export is enabled in the List Report and on the Object Page. When enabled, the Export button is displayed in the table toolbar.",
+          "descriptionSrcURL": "https://ui5.sap.com/sdk/#/topic/4bab6f2043814257974b52d4dafe1dcd",
           "type": "boolean"
         },
         "quickVariantSelection": {
@@ -482,7 +557,8 @@
           "description": "With quickVariantSelection you can switch on the multiple view feature (single table mode). It links to SelectionVariant (filters) or SelectionPresentationVariant (filters and sorters) you must have added to your annotations beforehand."
         },
         "condensedTableLayout": {
-          "description": "You can set the content density to condensed for ui.table on the list report and object page applications.",
+          "description": "Allows you to set the content density to condensed for ui.table on the List Report and Object Page.",
+          "descriptionSrcURL": "https://ui5.sap.com/sdk/#/topic/f3cc057e405c4fd58ee2ed42c557797c",
           "type": "boolean"
         }
       },
@@ -604,7 +680,7 @@
               "type": "string"
             }
           ],
-          "description": "Whether the action button should be visible on the screen.",
+          "description": "Allows you to define if the action button is visible on the screen.",
           "artifactType": "Manifest"
         },
         "enabled": {
@@ -620,7 +696,7 @@
               "type": "string"
             }
           ],
-          "description": "Whether the action button should be enabled. Default value is `true`.",
+          "description": "Allows you to define if the action should be enabled. The default value is \"true\".",
           "artifactType": "Manifest"
         }
       },
@@ -671,7 +747,8 @@
       "type": "object",
       "properties": {
         "width": {
-          "description": "A string type that represents CSS size values.\nRefer to https://openui5.hana.ondemand.com/api/sap.ui.core.CSSSize.",
+          "description": "A string type that represents CSS size values.\nRefer to https://ui5.sap.com/api/sap.ui.core.CSSSize",
+          "descriptionSrcURL": "https://ui5.sap.com/api/sap.ui.core.CSSSize",
           "type": "string",
           "artifactType": "Manifest"
         },
@@ -694,7 +771,8 @@
           "artifactType": "Manifest"
         },
         "width": {
-          "description": "A string type that represents CSS size values.\nRefer to https://openui5.hana.ondemand.com/api/sap.ui.core.CSSSize.",
+          "description": "A string type that represents CSS size values.\nRefer to https://ui5.sap.com/api/sap.ui.core.CSSSize",
+          "descriptionSrcURL": "https://ui5.sap.com/api/sap.ui.core.CSSSize",
           "type": "string",
           "artifactType": "Manifest"
         },
@@ -710,12 +788,13 @@
       "type": "object",
       "properties": {
         "navigateToInstance": {
-          "description": "By default, a navigation is automatically triggered after an action execution. If applications want to disable the navigation, they can do so using the manifest setting “navigateToInstance”.",
+          "description": "Allows you to disable the navigation. By default, navigation is automatically triggered after you have performed an action.",
+          "descriptionSrcURL": "https://ui5.sap.com/#/topic/2c65f07f44094012a511d6bd83f50f2d",
           "type": "boolean",
           "artifactType": "Manifest"
         },
         "enableAutoScroll": {
-          "description": "The \"enableAutoScroll\" allows you to scroll to the newly created or changed item after execution of an action",
+          "description": "Allows you to scroll to the newly created or changed item after you have performed an action.",
           "type": "boolean",
           "artifactType": "Manifest"
         }
@@ -739,8 +818,9 @@
           "type": "string"
         },
         "width": {
-          "description": "A string type that represents CSS size values.\nRefer to https://openui5.hana.ondemand.com/api/sap.ui.core.CSSSize.",
+          "description": "A string type that represents CSS size values.\nRefer to https://ui5.sap.com/api/sap.ui.core.CSSSize",
           "artifactType": "Manifest",
+          "descriptionSrcURL": "https://ui5.sap.com/api/sap.ui.core.CSSSize",
           "type": "string"
         },
         "template": {
@@ -875,7 +955,7 @@
         },
         "initialLoad": {
           "$ref": "#/definitions/InitialLoadType",
-          "description": "initialLoad defines whether or not the data in the table is automatically loaded.\n- Disabled - Data is never loaded when opening the app without an app state.\n- Enabled - Data is always loaded when opening the app.\n- Auto - Data is only loaded, if initial/preset filters are available (e.g. defined by \"SelectionVariant\" definition, URL parameters or user defaults).",
+          "description": "Allows you to define whether or not the data in the table is automatically loaded\n\n- Auto (default): An initial load of data only occurs if some default filter values have been set in the filter bar\n- Enabled: An initial load of data occurs for the standard variant\n- Disabled: An initial load of data does not occur for the standard variant, and the user has to actively click the Go button.",
           "artifactType": "Manifest"
         },
         "personalization": {
@@ -900,7 +980,7 @@
         },
         "selectionMode": {
           "$ref": "#/definitions/SelectionMode",
-          "description": "Applications can influence whether the table rows are selectable or not, and whether it allows for single selection or multiple selection. It can take the following values:\n- \"Auto\": This is the default value. In this mode, Fiori Elements first checks if there are any custom actions or IBN buttons in the table toolbar that require a context. If no such buttons are found, then no table selection is allowed in display mode. In edit mode too a selection is not allowed unless there is a Delete button in the table toolbar in which case multiple row selection will be allowed.\n- \"Multi\": This will allow end users to select multiple table records (in both display and edit mode)\n- \"Single\" This will allow end user to select only a single table record (in both display and edit mode)\n- \"None\": This will not allow the end user to select any table record in display mode. This will also be the case in edit mode unless the table has a delete button enabled, in which multiple selection is allowed in delete mode.",
+          "description": "Allows you to enable or disable row selection and choose between single or multiple row selection.\n\n- Auto: This type is now deprecated. Choose any of the following modes.\n- Multi (default): This type allows multiple table selections if relevant actions are available in the toolbar. In edit mode, multiple selection is possible with the delete button.\n- Single: This type allows single table selection if relevant actions are available in the toolbar. In edit mode, multiple selection is possible with the Delete button.\n- None: No table selection is possible in display mode. In edit mode, the selection (including multiple row selection) is still possible when the Delete button is available in the table toolbar.",
           "artifactType": "Manifest"
         },
         "selectAll": {
@@ -909,12 +989,13 @@
           "artifactType": "Manifest"
         },
         "selectionLimit": {
-          "description": "With the selectionLimit you can define how many items can be selected at a time,",
+          "description": "You can define how many items can be selected at a time using the selectionLimit.",
           "type": "number",
           "artifactType": "Manifest"
         },
         "enableExport": {
-          "description": "The exporting of the table to an Excel file is enabled in List Report tables by default. In Object Page, the export to Excel is available by default if the copy/paste feature is also available; otherwise it is disabled.\nTo disable the export in List Report or to enable it in Object Page, use the \"enableExport\" property and set it to false or true.",
+          "description": "By default, export is enabled in the List Report and on the Object Page. When enabled, the Export button is displayed in the table toolbar.",
+          "descriptionSrcURL": "https://ui5.sap.com/sdk/#/topic/4bab6f2043814257974b52d4dafe1dcd",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -924,7 +1005,8 @@
           "artifactType": "Manifest"
         },
         "condensedTableLayout": {
-          "description": "You can set the content density to condensed for ui.table on the list report and object page applications.",
+          "description": "Allows you to set the content density to condensed for ui.table on the List Report and Object Page.",
+          "descriptionSrcURL": "https://ui5.sap.com/sdk/#/topic/f3cc057e405c4fd58ee2ed42c557797c",
           "type": "boolean",
           "artifactType": "Manifest"
         }
@@ -1047,7 +1129,7 @@
         },
         "selectionMode": {
           "$ref": "#/definitions/SelectionMode",
-          "description": "Applications can influence whether the table rows are selectable or not, and whether it allows for single selection or multiple selection. It can take the following values:\n- \"Auto\": This is the default value. In this mode, Fiori Elements first checks if there are any custom actions or IBN buttons in the table toolbar that require a context. If no such buttons are found, then no table selection is allowed in display mode. In edit mode too a selection is not allowed unless there is a Delete button in the table toolbar in which case multiple row selection will be allowed.\n- \"Multi\": This will allow end users to select multiple table records (in both display and edit mode)\n- \"Single\" This will allow end user to select only a single table record (in both display and edit mode)\n- \"None\": This will not allow the end user to select any table record in display mode. This will also be the case in edit mode unless the table has a delete button enabled, in which multiple selection is allowed in delete mode.",
+          "description": "Allows you to enable or disable row selection and choose between single or multiple row selection.\n\n- Auto: This type is now deprecated. Choose any of the following modes.\n- Multi (default): This type allows multiple table selections if relevant actions are available in the toolbar. In edit mode, multiple selection is possible with the delete button.\n- Single: This type allows single table selection if relevant actions are available in the toolbar. In edit mode, multiple selection is possible with the Delete button.\n- None: No table selection is possible in display mode. In edit mode, the selection (including multiple row selection) is still possible when the Delete button is available in the table toolbar.",
           "artifactType": "Manifest"
         },
         "selectAll": {
@@ -1056,12 +1138,13 @@
           "artifactType": "Manifest"
         },
         "selectionLimit": {
-          "description": "With the selectionLimit you can define how many items can be selected at a time,",
+          "description": "You can define how many items can be selected at a time using the selectionLimit.",
           "type": "number",
           "artifactType": "Manifest"
         },
         "enableExport": {
-          "description": "The exporting of the table to an Excel file is enabled in List Report tables by default. In Object Page, the export to Excel is available by default if the copy/paste feature is also available; otherwise it is disabled.\nTo disable the export in List Report or to enable it in Object Page, use the \"enableExport\" property and set it to false or true.",
+          "description": "By default, export is enabled in the List Report and on the Object Page. When enabled, the Export button is displayed in the table toolbar.",
+          "descriptionSrcURL": "https://ui5.sap.com/sdk/#/topic/4bab6f2043814257974b52d4dafe1dcd",
           "type": "boolean",
           "artifactType": "Manifest"
         },
@@ -1071,7 +1154,8 @@
           "artifactType": "Manifest"
         },
         "condensedTableLayout": {
-          "description": "You can set the content density to condensed for ui.table on the list report and object page applications.",
+          "description": "Allows you to set the content density to condensed for ui.table on the List Report and Object Page.",
+          "descriptionSrcURL": "https://ui5.sap.com/sdk/#/topic/f3cc057e405c4fd58ee2ed42c557797c",
           "type": "boolean",
           "artifactType": "Manifest"
         }
@@ -1210,7 +1294,8 @@
       "type": "object",
       "properties": {
         "width": {
-          "description": "A string type that represents CSS size values.\nRefer to https://openui5.hana.ondemand.com/api/sap.ui.core.CSSSize.",
+          "description": "A string type that represents CSS size values.\nRefer to https://ui5.sap.com/api/sap.ui.core.CSSSize",
+          "descriptionSrcURL": "https://ui5.sap.com/api/sap.ui.core.CSSSize",
           "type": "string",
           "artifactType": "Manifest"
         },
@@ -1233,7 +1318,8 @@
           "artifactType": "Manifest"
         },
         "width": {
-          "description": "A string type that represents CSS size values.\nRefer to https://openui5.hana.ondemand.com/api/sap.ui.core.CSSSize.",
+          "description": "A string type that represents CSS size values.\nRefer to https://ui5.sap.com/api/sap.ui.core.CSSSize",
+          "descriptionSrcURL": "https://ui5.sap.com/api/sap.ui.core.CSSSize",
           "type": "string",
           "artifactType": "Manifest"
         },
@@ -1262,8 +1348,9 @@
           "type": "string"
         },
         "width": {
-          "description": "A string type that represents CSS size values.\nRefer to https://openui5.hana.ondemand.com/api/sap.ui.core.CSSSize.",
+          "description": "A string type that represents CSS size values.\nRefer to https://ui5.sap.com/api/sap.ui.core.CSSSize",
           "artifactType": "Manifest",
+          "descriptionSrcURL": "https://ui5.sap.com/api/sap.ui.core.CSSSize",
           "type": "string"
         },
         "template": {