@sap/ux-specification 1.96.26 → 1.96.28

package/dist/schemas/v4/BuildingBlocksConfig.json

@@ -0,0 +1,750 @@
+{
+  "type": "object",
+  "properties": {
+    "$filePath": {
+      "type": "string",
+      "hidden": true
+    },
+    "$schema": {
+      "type": "string",
+      "hidden": true
+    }
+  },
+  "additionalProperties": false,
+  "definitions": {
+    "sap.fe.macros.FlexibleColumnLayoutActions": {
+      "description": "Building block used specifically in an app using the flexible column layout to add the ‘expand’, ‘reduce’, and ‘close’ action buttons.Usage example: \n<f:DynamicPageTitle id=\"incidentProcessFlowDynamicPageTitle\">\n\t <f:navigationActions>\n\t   <macros:FlexibleColumnLayoutActions />\n\t </f:navigationActions>\n</f:DynamicPageTitle>\n<macro:FlexibleColumnLayoutActions />\n",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.FormElement": {
+      "description": "Building block used to create a form element containing a label and a field.",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "contextPath": {
+          "$ref": "#/definitions/sap.ui.model.Context",
+          "description": "contextPath",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "id": {
+          "type": "string",
+          "description": "The identifier of the table control.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "label": {
+          "type": "string",
+          "description": "Label shown for the field. If not set, the label from the annotations will be shown.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "metaPath": {
+          "$ref": "#/definitions/sap.ui.model.Context",
+          "description": "metaPath",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "visible": {
+          "type": "boolean",
+          "description": "If set to false, the FormElement is not rendered.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "fields": {
+          "description": "fields",
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.ui.core.Control"
+          },
+          "isViewNode": true,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.MacroMetadata": {
+      "description": "Base class for all SAP Fiori elements building blocks. This class is not meant to be used as a stand-alone class.",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.MicroChart": {
+      "description": "Building block used to create a MicroChart based on the metadata provided by OData V4.",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "batchGroupId": {
+          "type": "string",
+          "description": "Batch group ID along with which this call should be grouped.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "contextPath": {
+          "$ref": "#/definitions/sap.ui.model.Context",
+          "description": "contextPath",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "description": {
+          "type": "string",
+          "description": "Description for the MicroChart. If no description is provided, the description from the Chart annotation is used.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "hideOnNoData": {
+          "type": "boolean",
+          "description": "Show blank space in case there is no data in the chart",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "id": {
+          "type": "string",
+          "description": "ID of the MicroChart.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "isAnalytics": {
+          "type": "boolean",
+          "description": "Defines whether the MicroChart is part of an analytical table",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "metaPath": {
+          "$ref": "#/definitions/sap.ui.model.Context",
+          "description": "metaPath",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "navigationType": {
+          "$ref": "#/definitions/sap.fe.macros.NavigationType",
+          "description": "navigationType",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "onTitlePressed": {
+          "type": "string",
+          "description": "Event handler for onTitlePressed event",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "showOnlyChart": {
+          "type": "boolean",
+          "description": "To control the rendering of Title, Subtitle and Currency Labels. When the size is xs then we do not see the inner labels of the MicroChart as well.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "size": {
+          "type": "string",
+          "description": "Size of the MicroChart",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "title": {
+          "type": "string",
+          "description": "Title for the MicroChart. If no title is provided, the title from the Chart annotation is used.",
+          "metadata": {
+            "type": "Property"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.Paginator": {
+      "description": "Building block used to create a paginator control.Usage example: \n<macro:Paginator />\n",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "The identifier of the Paginator control.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "templateResourceBundle": {
+          "type": "boolean",
+          "description": "The identifier to get the tooltip for the paginator buttons",
+          "metadata": {
+            "type": "Property"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.Share": {
+      "description": "Building block used to create the ‘Share’ functionality.  Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with SAP Jam.  If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then the 'Save as Tile' option is not visible.Usage example: \n<macro:Share\n\tid=\"someID\"\n\tvisible=\"true\"\n/>\n",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "The identifier of the share control.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "shortCutExists": {
+          "type": "boolean",
+          "description": "Whether the share shortcut exists or not.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "visible": {
+          "type": "boolean",
+          "description": "Whether the share macro is visible or not.",
+          "metadata": {
+            "type": "Property"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.Chart": {
+      "description": "Building block used to create a chart based on the metadata provided by OData V4.\n\nUsually, a contextPath and metaPath is expected.Usage example:\n\n<macro:Chart id=\"Mychart\" contextPath=\"/RootEntity\" metaPath=\"@com.sap.vocabularies.UI.v1.Chart\" />\n\n",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "contextPath": {
+          "$ref": "#/definitions/sap.ui.model.Context",
+          "description": "contextPath",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "id": {
+          "type": "string",
+          "description": "ID of the chart",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "metaPath": {
+          "$ref": "#/definitions/sap.ui.model.Context",
+          "description": "metaPath",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "personalization": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "Parameter which sets the personalization of the MDC chart",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "selectionMode": {
+          "type": "string",
+          "description": "Specifies the selection mode",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "selectionChange": {
+          "type": "string",
+          "description": "An event triggered when chart selections are changed. The event contains information about the data selected/deselected and\nboolean flag that indicates whether data is selected or deselected.",
+          "metadata": {
+            "type": "Event"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.Field": {
+      "description": "Building block for creating a field based on the metadata provided by OData V4.\n\nUsually, a DataField or DataPoint annotation is expected, but the field can also be used to display a property from the entity type.Usage example:\n\n<macro:Field id=\"MyField\" metaPath=\"MyProperty\" />\n\n",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "contextPath": {
+          "type": "string",
+          "description": "Defines the path of the context used in the current page or block.\nThis setting is defined by the framework.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "formatOptions": {
+          "$ref": "#/definitions/sap.fe.macros.FieldFormatOptions",
+          "description": "formatOptions",
+          "isViewNode": true,
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "id": {
+          "type": "string",
+          "description": "The identifier of the Field control.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "metaPath": {
+          "type": "string",
+          "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "readOnly": {
+          "type": "boolean",
+          "description": "An expression that allows you to control the read-only state of the field.If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "semanticObject": {
+          "type": "string",
+          "description": "Option to add semantic objects to a field.\nValid options are either a single semantic object, a stringified array of semantic objects\nor a single binding expression returning either a single semantic object or an array of semantic objects",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "change": {
+          "type": "string",
+          "description": "An event containing details is triggered when the value of the field is changed.",
+          "metadata": {
+            "type": "Event"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.FilterBar": {
+      "description": "Building block for creating a FilterBar based on the metadata provided by OData V4.\n\nUsually, a SelectionFields annotation is expected.Usage example:\n\n<macro:FilterBar id=\"MyFilterBar\" metaPath=\"@com.sap.vocabularies.UI.v1.SelectionFields\" />\n\n",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "contextPath": {
+          "type": "string",
+          "description": "Defines the path of the context used in the current page or block.\nThis setting is defined by the framework.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "id": {
+          "type": "string",
+          "description": "The identifier of the filterbar control.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "metaPath": {
+          "type": "string",
+          "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "filterChanged": {
+          "type": "string",
+          "description": "This event is fired after either a filter value or the visibility of a filter item has been changed.\nThe event contains conditions that will be used as filters.",
+          "metadata": {
+            "type": "Event"
+          }
+        },
+        "search": {
+          "type": "string",
+          "description": "This event is fired when the Go button is pressed or after a condition change.",
+          "metadata": {
+            "type": "Event"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.Table": {
+      "description": "Building block used to create a table based on the metadata provided by OData V4.\n\nUsually, a LineItem or PresentationVariant annotation is expected, but the Table building block can also be used to display an EntitySet.Usage example:\n\n<macro:Table id=\"MyTable\" metaPath=\"@com.sap.vocabularies.UI.v1.LineItem\" />\n\n",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "busy": {
+          "type": "boolean",
+          "description": "An expression that allows you to control the 'busy' state of the table.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "contextPath": {
+          "type": "string",
+          "description": "Defines the path of the context used in the current page or block.\nThis setting is defined by the framework.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "enableAutoColumnWidth": {
+          "type": "boolean",
+          "description": "Specifies the header text that is shown in the table.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "enableExport": {
+          "type": "boolean",
+          "description": "Controls if the export functionality of the table is enabled or not.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "enableFullScreen": {
+          "type": "boolean",
+          "description": "Controls whether the table can be opened in fullscreen mode or not.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "enablePaste": {
+          "type": "boolean",
+          "description": "Controls if the paste functionality of the table is enabled or not.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "header": {
+          "type": "string",
+          "description": "Specifies the header text that is shown in the table.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "headerVisible": {
+          "type": "boolean",
+          "description": "Controls if the header text should be shown or not.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "id": {
+          "type": "string",
+          "description": "The identifier of the table control.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "metaPath": {
+          "type": "string",
+          "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "personalization": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "string"
+            }
+          ],
+          "description": "Controls which options should be enabled for the table personalization dialog.If it is set to `true`, all possible options for this kind of table are enabled.\nIf it is set to `false`, personalization is disabled.\n\nYou can also provide a more granular control for the personalization by providing a comma-separated list with the options you want to be available.\nAvailable options are:\n - Sort\n - Column\n - Filter\n",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "readOnly": {
+          "type": "boolean",
+          "description": "An expression that allows you to control the 'read-only' state of the table.If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "selectionMode": {
+          "type": "string",
+          "description": "Defines the selection mode to be used by the table.Allowed values are `None`, `Single`, `Multi` or `Auto`\n",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "type": {
+          "type": "string",
+          "description": "Defines the type of table that will be used by the macro to render the data.Allowed values are `GridTable` and `ResponsiveTable`\n",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "variantManagement": {
+          "type": "string",
+          "description": "Controls the kind of variant management that should be enabled for the table.Allowed values are `Page`, `Control` and `None`.\nIf the table is used within a SAP Fiori elements template, the default value will be taken from the current page variant management.\nOtherwise it's `None`.\n",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "title": {
+          "type": "string",
+          "description": "The text that will be displayed for table title",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "actions": {
+          "description": "actions",
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.table.Action"
+          },
+          "isViewNode": true,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation"
+          }
+        },
+        "columns": {
+          "description": "columns",
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.table.Column"
+          },
+          "isViewNode": true,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation"
+          }
+        },
+        "rowPress": {
+          "type": "string",
+          "description": "An event triggered when the user chooses a row; the event contains information about which row was chosen.You can set this in order to handle the navigation manually.\n",
+          "metadata": {
+            "type": "Event"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.ActionGroup": {
+      "description": "Definition of a actions group to be used inside the table toolbar",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "text": {
+          "type": "string",
+          "description": "The text that will be displayed for this action group",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "placement": {
+          "type": "string",
+          "description": "Defines where this action group should be placed relative to the defined anchor",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "anchor": {
+          "type": "string",
+          "description": "Reference to the key of another action or action group already displayed in the toolbar to properly place this one",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "actions": {
+          "description": "actions",
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/sap.fe.macros.table.Action"
+          },
+          "isViewNode": true,
+          "metadata": {
+            "path": [],
+            "type": "Aggregation"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.FieldFormatOptions": {
+      "description": "Additional format options for the field.",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "displayMode": {
+          "type": "string",
+          "description": " Defines how the field value and associated text will be displayed together. Allowed values are \"Value\", \"Description\", \"ValueDescription\" and \"DescriptionValue\"\n",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "measureDisplayMode": {
+          "type": "string",
+          "description": "Defines if and how the field measure will be displayed.Allowed values are \"Hidden\" and \"ReadOnly\"\n",
+          "metadata": {
+            "type": "Property"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.table.Action": {
+      "description": "Definition of a custom action to be used inside the table toolbar",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "anchor": {
+          "type": "string",
+          "description": "Reference to the key of another action already displayed in the toolbar to properly place this one",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "key": {
+          "type": "string",
+          "description": "Unique identifier of the action",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "placement": {
+          "type": "string",
+          "description": "Defines where this action should be placed relative to the defined anchorAllowed values are `Before` and `After`\n",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "press": {
+          "type": "string",
+          "description": "Event handler to be called when the user chooses the action",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "text": {
+          "type": "string",
+          "description": "The text that will be displayed for this action",
+          "metadata": {
+            "type": "Property"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    },
+    "sap.fe.macros.table.Column": {
+      "description": "Definition of a custom column to be used inside the table.The template for the column has to be provided as the default aggregation\n",
+      "isViewNode": true,
+      "type": "object",
+      "properties": {
+        "anchor": {
+          "type": "string",
+          "description": "Reference to the key of another column already displayed in the table to properly place this one",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "header": {
+          "type": "string",
+          "description": "The text that will be displayed for this column header",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "key": {
+          "type": "string",
+          "description": "Unique identifier of the column",
+          "metadata": {
+            "type": "Property"
+          }
+        },
+        "placement": {
+          "type": "string",
+          "description": "Defines where this column should be placed relative to the defined anchorAllowed values are `Before` and `After`\n",
+          "metadata": {
+            "type": "Property"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "metadata": {
+        "path": [],
+        "type": "Control"
+      }
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}