@sap/ux-specification 1.136.7 → 1.136.8

package/dist/schemas/v2/ListReportNewConfig.json

@@ -11,6 +11,10 @@
       "$ref": "#/definitions/ListHeader",
       "description": "Header"
     },
+    "filterBar": {
+      "$ref": "#/definitions/ListReportFilterBar",
+      "description": "Filter Bar"
+    },
     "$schema": {
       "type": "string"
     }
@@ -52,6 +56,363 @@
         }
       },
       "additionalProperties": false
+    },
+    "ListReportFilterBar": {
+      "description": "Filter Bar",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "annotationPath": {
+          "description": "Specify a SelectionVariant (in order to set default values for the filter bar), a PresentationVariant (in order to define the layout of the table), or a SelectionPresentationVariant (combining both)",
+          "type": "string",
+          "artifactType": "Manifest",
+          "descriptionSrcURL": "https://ui5.sap.com/sdk/#/topic/49a6ba5b8d6946208322a9f7e16837c2"
+        },
+        "liveMode": {
+          "description": "If liveMode is set, the search will be automatically triggered when a filter value is set.",
+          "type": "boolean",
+          "artifactType": "FlexChange",
+          "controlType": "sap.ui.comp.smartfilterbar.SmartFilterBar"
+        },
+        "smartVariantManagement": {
+          "description": "Controls whether smart variant management is active. Default is true.",
+          "type": "boolean",
+          "artifactType": "Manifest",
+          "descriptionSrcURL": "https://ui5.sap.com/sdk/#/topic/094fe8c8d8ac4f0eb4724b1a52d2ad61"
+        },
+        "variantManagementHidden": {
+          "description": "If you set the flag to true, then standard variant management is not available in the app. The app name is displayed instead.\nIf the flag is false or undefined, the standard variant management is available and can be enabled or disabled.",
+          "type": "boolean",
+          "artifactType": "Manifest",
+          "descriptionSrcURL": "https://ui5.sap.com/sdk/#/topic/094fe8c8d8ac4f0eb4724b1a52d2ad61"
+        },
+        "subTitleIfVariantMgmtHidden": {
+          "description": "You can choose an app-specific title by setting the corresponding value for the subTitleIfVariantMgmtHidden property.",
+          "i18nClassification": "TIT: Subtitle if variant management is hidden",
+          "type": "string",
+          "artifactType": "Manifest",
+          "descriptionSrcURL": "https://ui5.sap.com/sdk/#/topic/094fe8c8d8ac4f0eb4724b1a52d2ad61"
+        },
+        "showClearOnFB": {
+          "description": "Handles the visibility of the Clear button on the filter bar.",
+          "type": "boolean",
+          "artifactType": "FlexChange",
+          "controlType": "sap.ui.comp.smartfilterbar.SmartFilterBar"
+        },
+        "showFilterConfiguration": {
+          "description": "Handles the visibility of the Filter button on the filter bar.",
+          "type": "boolean",
+          "artifactType": "FlexChange",
+          "controlType": "sap.ui.comp.smartfilterbar.SmartFilterBar"
+        },
+        "showRestoreOnFB": {
+          "description": "Handles the visibility of the Restore button on the filter bar.",
+          "type": "boolean",
+          "artifactType": "FlexChange",
+          "controlType": "sap.ui.comp.smartfilterbar.SmartFilterBar"
+        },
+        "dateSettings": {
+          "$ref": "#/definitions/DateRange",
+          "description": "Defines the date settings for fields in the smart filter bar."
+        },
+        "selectionFields": {
+          "$ref": "#/definitions/FilterFields",
+          "description": "Filter Fields"
+        }
+      },
+      "additionalProperties": false
+    },
+    "DateRange": {
+      "type": "object",
+      "properties": {
+        "useDateRange": {
+          "description": "If set to true all date fields with filter restriction interval will be treated as DateTimeRange filters.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "selectedValues": {
+          "description": "Defines a set of standard date range values that you want to include or exclude.",
+          "type": "array",
+          "items": {
+            "enum": [
+              "DATE",
+              "DATERANGE",
+              "DAYS",
+              "FROM",
+              "LAST2WEEKS",
+              "LAST3WEEKS",
+              "LAST4WEEKS",
+              "LAST5WEEKS",
+              "LASTDAYS",
+              "LASTMONTH",
+              "LASTMONTHS",
+              "LASTQUARTER",
+              "LASTQUARTERS",
+              "LASTWEEK",
+              "LASTWEEKS",
+              "LASTYEAR",
+              "LASTYEARS",
+              "MONTH",
+              "NEXT",
+              "NEXT2WEEKS",
+              "NEXT3WEEKS",
+              "NEXT4WEEKS",
+              "NEXT5WEEKS",
+              "NEXTDAYS",
+              "NEXTMONTH",
+              "NEXTMONTHS",
+              "NEXTQUARTER",
+              "NEXTQUARTERS",
+              "NEXTWEEK",
+              "NEXTWEEKS",
+              "NEXTYEARS",
+              "QUARTER",
+              "QUARTER1",
+              "QUARTER2",
+              "QUARTER3",
+              "QUARTER4",
+              "SPECIFICMONTH",
+              "THISMONTH",
+              "THISQUARTER",
+              "THISWEEK",
+              "TO",
+              "TODAY",
+              "TODAYFROMTO",
+              "TOMORROW",
+              "WEEK",
+              "YEAR",
+              "YEARTODATE",
+              "YESTERDAY"
+            ],
+            "type": "string"
+          },
+          "artifactType": "Manifest"
+        },
+        "exclude": {
+          "description": "This property is set to True by default. This excludes all values given as selectedValues from the list of date range filters.\nIf the exclude property is set to False, the application shows only selected values in the list of date range filters.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
+    "FilterFields": {
+      "description": "Filter Fields",
+      "isViewNode": true,
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#/definitions/FilterField"
+      }
+    },
+    "FilterField": {
+      "description": "Filter Field",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "selectedValues": {
+          "description": "Defines a set of standard date range values that you want to include or exclude.",
+          "type": "array",
+          "items": {
+            "enum": [
+              "DATE",
+              "DATERANGE",
+              "DAYS",
+              "FROM",
+              "LAST2WEEKS",
+              "LAST3WEEKS",
+              "LAST4WEEKS",
+              "LAST5WEEKS",
+              "LASTDAYS",
+              "LASTMONTH",
+              "LASTMONTHS",
+              "LASTQUARTER",
+              "LASTQUARTERS",
+              "LASTWEEK",
+              "LASTWEEKS",
+              "LASTYEAR",
+              "LASTYEARS",
+              "MONTH",
+              "NEXT",
+              "NEXT2WEEKS",
+              "NEXT3WEEKS",
+              "NEXT4WEEKS",
+              "NEXT5WEEKS",
+              "NEXTDAYS",
+              "NEXTMONTH",
+              "NEXTMONTHS",
+              "NEXTQUARTER",
+              "NEXTQUARTERS",
+              "NEXTWEEK",
+              "NEXTWEEKS",
+              "NEXTYEARS",
+              "QUARTER",
+              "QUARTER1",
+              "QUARTER2",
+              "QUARTER3",
+              "QUARTER4",
+              "SPECIFICMONTH",
+              "THISMONTH",
+              "THISQUARTER",
+              "THISWEEK",
+              "TO",
+              "TODAY",
+              "TODAYFROMTO",
+              "TOMORROW",
+              "WEEK",
+              "YEAR",
+              "YEARTODATE",
+              "YESTERDAY"
+            ],
+            "type": "string"
+          },
+          "artifactType": "Manifest"
+        },
+        "exclude": {
+          "description": "This property is set to True by default which excludes all values given as selectedValues from the list of date range filters.\nIf this property is set to False, the application shows only selected values in the list of date range filters.",
+          "type": "boolean",
+          "artifactType": "Manifest"
+        },
+        "customDateRangeImplementation": {
+          "description": "This property references a JS class, which can be used to modify the date range value list.\nYou can either remove the standard data range values or add custom values.\nThe customDateRangeImplementation setting takes priority followed by filter and selectedValues when excluding date range types.",
+          "type": "string",
+          "artifactType": "Manifest"
+        },
+        "filter": {
+          "description": "You can use the filter settings to include and exclude specific date range values.",
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "path": {
+                "$ref": "#/definitions/FilterPathType",
+                "description": "Choose 'key' to define filter values for single values of the date range, or 'category' to filter by a whole subset."
+              },
+              "contains": {
+                "description": "Specifies a filter describing a set of values of the date range type.",
+                "type": "string"
+              },
+              "equals": {
+                "description": "Defines a single value of the standard date range type.",
+                "type": "array",
+                "items": {
+                  "enum": [
+                    "DATE",
+                    "DATERANGE",
+                    "DAYS",
+                    "FROM",
+                    "LAST2WEEKS",
+                    "LAST3WEEKS",
+                    "LAST4WEEKS",
+                    "LAST5WEEKS",
+                    "LASTDAYS",
+                    "LASTMONTH",
+                    "LASTMONTHS",
+                    "LASTQUARTER",
+                    "LASTQUARTERS",
+                    "LASTWEEK",
+                    "LASTWEEKS",
+                    "LASTYEAR",
+                    "LASTYEARS",
+                    "MONTH",
+                    "NEXT",
+                    "NEXT2WEEKS",
+                    "NEXT3WEEKS",
+                    "NEXT4WEEKS",
+                    "NEXT5WEEKS",
+                    "NEXTDAYS",
+                    "NEXTMONTH",
+                    "NEXTMONTHS",
+                    "NEXTQUARTER",
+                    "NEXTQUARTERS",
+                    "NEXTWEEK",
+                    "NEXTWEEKS",
+                    "NEXTYEARS",
+                    "QUARTER",
+                    "QUARTER1",
+                    "QUARTER2",
+                    "QUARTER3",
+                    "QUARTER4",
+                    "SPECIFICMONTH",
+                    "THISMONTH",
+                    "THISQUARTER",
+                    "THISWEEK",
+                    "TO",
+                    "TODAY",
+                    "TODAYFROMTO",
+                    "TOMORROW",
+                    "WEEK",
+                    "YEAR",
+                    "YEARTODATE",
+                    "YESTERDAY"
+                  ],
+                  "type": "string"
+                }
+              },
+              "exclude": {
+                "description": "This property is set to True by default which excludes all values given as selectedValues from the list of date range filters.\nIf this property is set to False, the application shows only selected values in the list of date range filters.",
+                "type": "boolean"
+              }
+            },
+            "additionalProperties": false,
+            "required": [
+              "path"
+            ]
+          },
+          "artifactType": "Manifest"
+        },
+        "defaultValue": {
+          "$ref": "#/definitions/DefaultDateRange",
+          "description": "You can set a default value for semantic date range.",
+          "artifactType": "Manifest"
+        }
+      },
+      "additionalProperties": false
+    },
+    "FilterPathType": {
+      "enum": [
+        "category",
+        "key"
+      ],
+      "type": "string"
+    },
+    "DefaultDateRange": {
+      "type": "object",
+      "properties": {
+        "operation": {
+          "$ref": "#/definitions/DefaultDateRangeValueEnum",
+          "description": "The operation property is the value that will be set for semantic date range."
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "operation"
+      ]
+    },
+    "DefaultDateRangeValueEnum": {
+      "enum": [
+        "DATETOYEAR",
+        "LAST2WEEKS",
+        "LAST3WEEKS",
+        "LAST4WEEKS",
+        "LAST5WEEKS",
+        "LASTMONTH",
+        "LASTQUARTER",
+        "LASTWEEK",
+        "LASTYEAR",
+        "QUARTER1",
+        "QUARTER2",
+        "QUARTER3",
+        "QUARTER4",
+        "THISMONTH",
+        "THISQUARTER",
+        "THISWEEK",
+        "THISYEAR",
+        "TODAY",
+        "TOMORROW",
+        "YEARTODATE",
+        "YESTERDAY"
+      ],
+      "type": "string"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#"