{ "type": "object", "metadata": { "namespaces": [ "sap.fe.macros", "sap.fe.macros.chart", "sap.fe.macros.controls", "sap.fe.macros.field", "sap.fe.macros.filterBar", "sap.fe.macros.form", "sap.fe.macros.microchart", "sap.fe.macros.richtexteditor", "sap.fe.macros.share", "sap.fe.macros.table", "sap.fe.macros.controls.section" ] }, "properties": { "$filePath": { "type": "string", "hidden": true }, "$schema": { "type": "string", "hidden": true } }, "additionalProperties": false, "definitions": { "sap.fe.macros.AINotice": { "description": "Building block that displays a AI notice.\nIt's used to display information related to AI features. This information is rendered either\nas a link if the aggregation popoverContent is defined or as a label if there is no aggregation popoverContent.\n", "isViewNode": true, "type": "object", "properties": { "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "popoverContent": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.ui.core.Control" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control", "defaultAggregation": "popoverContent" } }, "sap.fe.macros.Chart": { "description": "Building block used to create a chart based on the metadata provided by OData V4.\nOverview of Building Blocks\n\t\t\t\n\nUsually, a contextPath and metaPath is expected.\nUsage example:\n\n<macros:Chart id=\"MyChart\" contextPath=\"/RootEntity\" metaPath=\"@com.sap.vocabularies.UI.v1.Chart\" />\n\n", "isViewNode": true, "type": "object", "properties": { "contextPath": { "type": "string", "description": "Metadata path to the entitySet or navigationProperty", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "header": { "type": "string", "description": "Specifies the header text that is shown in the chart", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "i18nClassification": "HED: Header of the chart" }, "headerVisible": { "type": "boolean", "description": "Controls if the header text should be shown or not", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Metadata path to the presentation context (UI.Chart with or without a qualifier)", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "personalization": { "type": "string", "description": "Controls which options should be enabled for the chart personalization dialog.\nIf it is set to `true`, all possible options for this kind of chart 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- Type\n- Item\n- Filter\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "selectionMode": { "type": "string", "description": "Defines the selection mode to be used by the chart.\nAllowed values are `None`, `Single` or `Multiple`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "None", "Single", "Multiple" ] }, "variantManagement": { "type": "string", "description": "Controls the kind of variant management that should be enabled for the chart.\nAllowed value is `Control`.\nIf set with value `Control`, a variant management control is seen within the chart and the chart is linked to this.\nIf not set with any value, variant management control is not available for this chart.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "", "Control" ] }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "actionOverflowGroups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.chart.OverflowGroup" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "actions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.chart.Action" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "selectionChange": { "type": "string", "description": "An event triggered when chart selections are changed. The event contains information about the data selected/deselected and the Boolean flag that indicates whether data is selected or deselected.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.CollaborativeDraftHandler": { "description": "A BuildingBlock to watch the lock status of a property and to react on changes.", "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, and can be overwritten.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showAvatar": { "type": "boolean", "description": "If set to true, the standard Avatar control is displayed to indicate the lock status.\nIf set to false, nothing is displayed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "avatarPress": { "type": "string", "description": "Event fired when the user clicks on the avatar.\nParameters:\n- lockingUserID: The ID of the user locking the property\n- lockingUserName: The name of the user locking the property\n- lockingUserInitials: The initials of the user locking the property\n- lockingUserColor: The color associated to the user locking the property\n", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "lockChange": { "type": "string", "description": "Event fired when the lock status changes.\nParameters:\n- isLocked : True if the property is locked, false otherwise\n- lockingUserID: The ID of the user locking the property (undefined if not locked)\n- lockingUserName: The name of the user locking the property (undefined if not locked)\n- lockingUserInitials: The initials of the user locking the property (undefined if not locked)\n- lockingUserColor: The color associated to the user locking the property (undefined if not locked)\n", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.CollectionBindingInfo": { "description": "API to add parameters to the collection binding info.", "isViewNode": true, "type": "object", "properties": { "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.ConditionalSwitch": { "description": "Defines a conditional template that renders content based on the evaluation of a set of switchProperties.\nThe switchProperties are defined using the sap.fe.macros.ConditionalSwitchProperty building block.", "isViewNode": true, "type": "object", "properties": { "factory": { "$ref": "#/definitions/function", "description": "A function that returns the content to be rendered based on the evaluation of the switchProperties.\nThe function receives an object with the switchProperties as key-value pairs, the binding context, and the displayed control.\nThe function should return a single UI5 control.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.ConditionalSwitchProperty": { "description": "Defines a property with a key and a value that can be used in conditional templates.\nWhen the value is changed, a `valueChanged` event is fired.", "isViewNode": true, "type": "object", "properties": { "key": { "type": "string", "description": "The key of the property.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "value": { "type": "any", "description": "The value of the property.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "valueChanged": { "type": "string", "description": "Event fired when the value of the property is changed.\nThis is used internally by the `ConditionalTemplate` control to react to changes in the property value.", "artifactType": "XMLProperty", "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.\nWhen creating a Field building block, you must provide an ID to ensure everything works correctly.\nUsage example:\n\n<macros:Field id=\"MyField\" metaPath=\"MyProperty\" />\n\nOverview of Building Blocks\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.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "description": { "type": "string", "description": "This is used to optionally provide an external description that comes from a different model than the oData model.\nThis should be used in conjunction with the value property.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "readOnly": { "type": "boolean", "description": "An expression that allows you to control the read-only state of the field.\nIf you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "semanticObject": { "type": "string", "description": "Option to add semantic objects for a field.\nThis parameter overwrites the semantic objects defined through annotations.\nValid options are either a single semantic object, a stringified array of semantic objects,\na formatter or a single binding expression returning either a single semantic object or an array of semantic objects.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "value": { "type": "string", "description": "This is used to optionally provide an external value that comes from a different model than the OData model.\nIt is designed to work with a field with value help, and without support for complex value help (currency / unit).", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "formatOptions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.field.FieldFormatOptions" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "A set of options that can be configured." }, "change": { "type": "string", "description": "An event containing details is triggered when the value of the field is changed.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "liveChange": { "type": "string", "description": "An event containing details is triggered when the value of the field is live changed.\nNote: Browsing autocomplete suggestions does not fire the event.\n", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.FormElement": { "description": "Building block used to create a form element based on the metadata provided by OData V4.", "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", "artifactType": "XMLProperty", "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.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "label": { "type": "string", "description": "Label shown for the field. If not set, the label from the annotations will be shown.", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "i18nClassification": "FLD: Label of the form element" }, "metaPath": { "type": "string", "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "placement": { "type": "string", "description": "Determines where this column should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "After", "Before" ] }, "visible": { "type": "boolean", "description": "If set to false, the FormElement is not rendered.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "fields": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.ui.core.Control" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.KPITag": { "description": "Building block used to create a KPI tag.", "isViewNode": true, "type": "object", "properties": { "number": { "type": "string", "description": "The Number to be displayed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showIcon": { "type": "boolean", "description": "Set it to `true` if the KPI should display its status icon.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "status": { "type": "string", "description": "The Status to be displayed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Success", "Error", "Warning", "None", "Information" ] }, "text": { "type": "string", "description": "The Text to be displayed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "i18nClassification": "TXT: Text of the KPITag" }, "tooltip": { "type": "string", "description": "The Tooltip to be displayed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "i18nClassification": "CAP: Tooltip of the KPITag" }, "unit": { "type": "string", "description": "The Unit of Measure of the number to be displayed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "press": { "type": "string", "description": "An event is triggered when the KPI is pressed.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.MacroAPI": { "description": "Base API control for building blocks.", "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.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.MessageButton": { "description": "Building block used to show bound messages.\nThe Message Button Building Block gets the bound messages from the MessageModel.\nUsage example:\n\n<macros:MessageButton visibilityChange=\".handler.onMessageButtonVisibilityChange\" />\n\n", "isViewNode": true, "type": "object", "properties": { "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "visibilityChange": { "type": "string", "description": "The event is triggered when the message button's visibility changes.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "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.\nOverview of Micro Chart Building Block\n\t\t\t\n\nUsually, a contextPath and metaPath is expected.\nUsage example:\n\n<macros:MicroChart id=\"MyMicroChart\" contextPath=\"/RootEntity\" metaPath=\"@com.sap.vocabularies.UI.v1.Chart\" />\n\n \nsap.ui.require([\"sap/fe/macros/MicroChart\"], function(MicroChart) {\n\t ...\n\t new MicroChart(\"myMicroChart\", {metaPath:\"@com.sap.vocabularies.UI.v1.Chart\"})\n})\n\n", "isViewNode": true, "type": "object", "properties": { "contextPath": { "type": "string", "description": "context path to the MicroChart.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "hideOnNoData": { "type": "boolean", "description": "Show blank space in case there is no data in the chart", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "linkAriaText": { "type": "string", "description": "Custom ARIA text for the title link.\nThis property is only used when titleAsLink is set to true.\nIf not provided, default ARIA text based on the navigationType is used.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Metadata path to the MicroChart.", "artifactType": "XMLProperty", "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\nnot see the inner labels of the MicroChart as well.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "size": { "type": "string", "description": "Size of the MicroChart", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "XS", "S", "M", "L" ] }, "titleAsLink": { "type": "boolean", "description": "Determines whether the micro chart title is displayed as a link or as a text.\nWhen set to true, the title is rendered as a clickable link.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "titlePress": { "type": "string", "description": "Event fired when the micro chart title link is pressed.\nThe event provides the binding context of the micro chart in the event parameters.\nThis event is only fired when titleAsLink is set to true.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.MultiValueField": { "description": "Building block for creating a MultiValueField based on the metadata provided by OData V4.\n\nThe MultiValueField can be used to display either a DataField or Property directly. It has to point to a collection property.\n\nUsage example:\n\n<macro:MultiValueField\nid=\"SomeUniqueIdentifier\"\ncontextPath=\"{entitySet>}\"\nmetaPath=\"{dataField>}\"\n/>\n", "isViewNode": true, "type": "object", "properties": { "contextPath": { "type": "string", "description": "The context path provided for the MultiValueField", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "items": { "type": "any", "description": "Property added to be able to add data / items to the multi-input field using a different model", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Defines the relative Metadata path to the MultiValueField.\nThe metaPath should point to a Property or DataField.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "readOnly": { "type": "boolean", "description": "The readOnly flag", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.Page": { "description": "Building block used to create a custom page with a title and the content. By default, the page includes a title.", "isViewNode": true, "type": "object", "properties": { "avatarImageFitType": { "type": "string", "description": "ImageFitType of the avatar image. This property is only considered if the title property is defined.", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Cover", "Contain" ] }, "avatarSrc": { "type": "string", "description": "Source of the avatar image. This property is considered only if the title property is defined.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "description": { "type": "string", "description": "Provides additional details of the page. This property is considered only if the title property is defined.\nCan be a string or a binding info object.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showFooter": { "type": "boolean", "description": "Controls the visibility of the footer.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "title": { "type": "string", "description": "Title of the page. If no title is provided, the title, avatar, and description are derived from the unqualified HeaderInfo annotation associated with the entity.\nCan be a string or a binding info object.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "actions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.ui.core.Control" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "breadcrumbs": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.ui.core.Control" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "footer": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.ui.core.Control" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "Footer content (for example, toolbar with buttons)." }, "headerContent": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.ui.core.Control" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "items": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.ui.core.Control" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "navigationActions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.ui.core.Control" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "titleContent": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.ui.core.Control" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control", "defaultAggregation": "items" } }, "sap.fe.macros.Paginator": { "description": "Building block used to create a paginator control.\nUsage example:\n\n<macros:Paginator />\n\n", "isViewNode": true, "type": "object", "properties": { "ariaTitle": { "type": "string", "description": "Title of the object that is readout by screen readers when the next/previous item is loaded via keyboard focus on the paginator button.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.RichTextEditor": { "description": "Building block that exposes the RichTextEditor UI5 control.\nIt's used to enter formatted text, and uses the third-party component called TinyMCE.\n", "isViewNode": true, "type": "object", "properties": { "excludeDefaultPlugins": { "type": "boolean", "description": "With the 'excludeDefaultPlugins' you can ask to remove the plugins that will be added by default\nThe default plugins are \"emoticons\" \"directionality\" \"image\" \"table\" \"link\" \"powerpaste\".", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "height": { "$ref": "#/definitions/sap.ui.core.CSSSize", "description": "Height of RichTextEditor control in CSS units.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "readOnly": { "type": "boolean", "description": "Use the readOnly attribute to override the edit flow of the page.\nBy setting 'readOnly' to true, a FormattedText will be displayed instead of the editor.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "required": { "type": "boolean", "description": "Use the 'required' attribute to make sure that the editor is filled with some text.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "value": { "type": "string", "description": "The value contained in the editor. You can use this attribute to set a default value.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "buttonGroups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.richtexteditor.ButtonGroup" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "plugins": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.richtexteditor.Plugin" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.RichTextEditorWithMetadata": { "description": "Metadata-driven building block that exposes the RichTextEditor UI5 control.\nIt's used to enter formatted text and uses the third-party component called TinyMCE.\n", "isViewNode": true, "type": "object", "properties": { "contextPath": { "type": "string", "description": "The context path of the property displayed", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "The metaPath of the displayed property", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "excludeDefaultPlugins": { "type": "boolean", "description": "With the 'excludeDefaultPlugins' you can ask to remove the plugins that will be added by default\nThe default plugins are \"emoticons\" \"directionality\" \"image\" \"table\" \"link\" \"powerpaste\".", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "height": { "$ref": "#/definitions/sap.ui.core.CSSSize", "description": "Height of RichTextEditor control in CSS units.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "readOnly": { "type": "boolean", "description": "Use the readOnly attribute to override the edit flow of the page.\nBy setting 'readOnly' to true, a FormattedText will be displayed instead of the editor.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "required": { "type": "boolean", "description": "Use the 'required' attribute to make sure that the editor is filled with some text.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "value": { "type": "string", "description": "The value contained in the editor. You can use this attribute to set a default value.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "buttonGroups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.richtexteditor.ButtonGroup" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "plugins": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.richtexteditor.Plugin" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.Share": { "description": "Building block used to create the ‘Share’ functionality.\n\nPlease note that the 'Share in SAP Jam' option is only available on platforms that are integrated with SAP Jam.\n\nIf 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.\nUsage example:\n\n<macros:Share\nid=\"someID\"\nvisible=\"true\"\n/>\n\nOverview of Building Blocks\n\t\t\t\n", "isViewNode": true, "type": "object", "properties": { "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "shareOptions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.share.ShareOptions" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "Supported Share options sap.fe.macros.share.ShareOptions." } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control", "defaultAggregation": "shareOptions" } }, "sap.fe.macros.Status": { "description": "Building block to display a status and criticality.", "isViewNode": true, "type": "object", "properties": { "colorPalette": { "type": "string", "description": "Color palette to be used by the control. The supported values are \"Standard\" (default) and \"Pastel\".", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Standard", "Pastel" ] }, "contextPath": { "type": "string", "description": "Context path for the binding context.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "inverted": { "type": "boolean", "description": "Determines whether the background color reflects the set state of the ObjectStatus instead of the control's text.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "largeDesign": { "type": "boolean", "description": "Indicates whether the ObjectStatus should be displayed in large design mode.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Metadata path to the DataField annotation or property.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "reactiveAreaMode": { "type": "string", "description": "When the Status is clickable, it defines the size of the reactive area of the clickable element:\n- ReactiveAreaMode.Inline - The Status is displayed as part of a sentence.\n- ReactiveAreaMode.Overlay - The Status is displayed as an overlay on top of other interactive parts of the page.\nNote: It is designed to make the clickable element easier to activate and helps meet the WCAG 2.2 Target Size requirement. It is applicable only for the SAP Horizon themes. Note: The size of the reactive area is sufficiently large to help users avoid accidentally selecting (clicking or tapping) unintended UI elements. UI elements positioned over other parts of the page may need an invisible active touch area. This ensures that no elements beneath are activated accidentally when the user tries to interact with the overlay element.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Inline", "Overlay" ] }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "press": { "type": "string", "description": "Press event fired when the ObjectStatus is clicked.", "artifactType": "XMLProperty", "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, PresentationVariant, or SelectionPresentationVariant annotation is expected, but the Table building block can also be used to display an EntitySet.\n\nIf a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.\n\nIf a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that also has a UI.LineItem as the first property of the Visualizations.\nUsage example:\n\n<macros:Table id=\"MyTable\" metaPath=\"@com.sap.vocabularies.UI.v1.LineItem\" />\n\nOverview of Table Building Blocks\n\t\t\t\n", "isViewNode": true, "type": "object", "properties": { "busy": { "type": "boolean", "description": "An expression that allows you to control the 'busy' state of the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "condensedTableLayout": { "type": "boolean", "description": "Determines whether the table adapts to the condensed layout.", "artifactType": "XMLProperty", "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.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "disableColumnFreeze": { "type": "boolean", "description": "Determines whether the number of fixed columns can be configured in the Column Settings dialog.\nThis property doesn't apply for responsive tables\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "disableCopyToClipboard": { "type": "boolean", "description": "Controls if the copy functionality of the table is disabled or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableAutoColumnWidth": { "type": "boolean", "description": "Specifies if the column width is automatically calculated.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableExport": { "type": "boolean", "description": "Controls if the export functionality of the table is enabled or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableFullScreen": { "type": "boolean", "description": "Controls whether the table can be opened in full-screen mode or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enablePaste": { "type": "boolean", "description": "Controls if the paste functionality of the table is enabled or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enablePastingOfComputedProperties": { "type": "boolean", "description": "Determine whether the data copied to the computed columns is sent to the back end.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableSelectAll": { "type": "boolean", "description": "Determines whether the Clear All button is enabled by default.\nTo enable the Clear All button by default, you must set this property to false.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "exportFileName": { "type": "string", "description": "Configures the file name of exported table.\nIt's limited to 31 characters. If the name is longer, it is truncated.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "exportRequestSize": { "type": "number", "description": "Maximum allowed number of records to be exported in one request.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "exportSheetName": { "type": "string", "description": "Configures the sheet name of exported table.\nIt's limited to 31 characters. If the name is longer, it is truncated.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "filterBar": { "type": "string", "description": "ID of the FilterBar building block associated with the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "frozenColumnCount": { "type": "number", "description": "Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.\nThis property is not relevant for responsive tables\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "header": { "type": "string", "description": "Specifies the header text that is shown in the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "i18nClassification": "TIT: Header of the table" }, "headerVisible": { "type": "boolean", "description": "Controls if the header text should be shown or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "ignoredFields": { "type": "string", "description": "Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.\nThe table building block is not going to create built-in columns or offer table personalization for comma-separated value of fields that are provided in the ignoredfields.\nAny column referencing an ignored field is to be removed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isSearchable": { "type": "boolean", "description": "Defines whether to display the search action.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Defines the relative path to a LineItem, PresentationVariant, or SelectionPresentationVariant in the metamodel, based on the current contextPath.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "modeForNoDataMessage": { "type": "string", "description": "Changes the size of the IllustratedMessage in the table, or removes it completely.\nAllowed values are `illustratedMessage-Auto`, `illustratedMessage-Base`, `illustratedMessage-Dialog`, `illustratedMessage-Dot`, `illustratedMessage-Scene`, `illustratedMessage-Spot` or `text`.", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "illustratedMessage-Auto", "illustratedMessage-Base", "illustratedMessage-Medium", "illustratedMessage-Dot", "illustratedMessage-ExtraSmall", "illustratedMessage-Scene", "illustratedMessage-Large", "illustratedMessage-Spot", "illustratedMessage-Small", "text" ] }, "personalization": { "type": "string", "description": "Controls which options should be enabled for the table personalization dialog.\nIf 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- Group\n\nThe Group option is only applicable to analytical tables and responsive tables.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "popinLayout": { "type": "string", "description": "Defines the layout options of the table popins. Only applies to responsive tables.\nAllowed values are `Block`, `GridLarge`, and `GridSmall`.\n- `Block`: Sets a block layout for rendering the table popins. The elements inside the popin container are rendered one below the other.\n- `GridLarge`: Sets a grid layout for rendering the table popins. The grid width for each table popin is comparatively larger than GridSmall, so this layout allows less content to be rendered in a single popin row.\n- `GridSmall`: Sets a grid layout for rendering the table popins. The grid width for each table popin is small, so this layout allows more content to be rendered in a single popin row.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Block", "GridLarge", "GridSmall" ] }, "readOnly": { "type": "boolean", "description": "An expression that allows you to control the 'read-only' state of the table.\nIf you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "rowCount": { "type": "number", "description": "Number of rows to be displayed in the table. Does not apply to responsive tables.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "rowCountMode": { "type": "string", "description": "Defines how the table handles the visible rows. Does not apply to responsive tables.\nAllowed values are `Auto`, `Fixed`, and `Interactive`.\n- If set to `Fixed`, the table always has as many rows as defined in the rowCount property.\n- If set to `Auto`, the number of rows is changed by the table automatically. The table adjusts the number of rows based on the available space, which is limited by the surrounding container. The table cannot have fewer rows than defined in the `rowCount` property.\n- If set to `Interactive` the table can have as many rows as defined in the rowCount property. The number of rows can be modified by dragging the resizer.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Auto", "Fixed", "Interactive" ] }, "scrollThreshold": { "type": "number", "description": "Defines how many additional data records are requested from the back-end system when the user scrolls vertically in the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "selectionLimit": { "type": "number", "description": "Defines the maximum number of rows that can be selected at once in the table.\nThis property does not apply to responsive tables.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "selectionMode": { "type": "string", "description": "Defines the selection mode to be used by the table.\nAllowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti`, or `Auto`.\nIf set to `Single`, `Multi`, or `Auto`, SAP Fiori elements hooks into the standard lifecycle to determine a consistent selection mode.\nIf set to `ForceSingle` or `ForceMulti`, note this may not adhere to the SAP Fiori guidelines.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "None", "Single", "Multi", "Auto", "ForceMulti", "ForceSingle" ] }, "threshold": { "type": "number", "description": "Defines the number of records to be initially requested from the back end.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "type": { "type": "string", "description": "Defines the type of table that is used by the building block to render data.\nAllowed values are `GridTable`, `ResponsiveTable`, and `AnalyticalTable`.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "GridTable", "ResponsiveTable", "AnalyticalTable" ] }, "variantManagement": { "type": "string", "description": "Controls the kind of variant management that should be enabled for the table.\nAllowed value is `Control`.\nIf set with value `Control`, a variant management control is seen within the table and the table is linked to this.\nIf not set with any value, control level variant management is not available for this table.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "None", "Page", "Control" ] }, "widthIncludingColumnHeader": { "type": "boolean", "description": "Indicates if the column header should be a part of the width calculation.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "creationMode": { "$ref": "#/definitions/sap.fe.macros.table.TableCreationOptions", "description": "A set of options that can be configured.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "actionOverflowGroups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.OverflowGroup" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "actions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.Action" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "analyticalConfiguration": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.AnalyticalConfiguration" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "A set of options that can be configured to control the aggregation behavior" }, "columns": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.Column" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "massEdit": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.MassEdit" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "Aggregate mass edit of the table." }, "quickVariantSelection": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.QuickVariantSelection" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "Aggregate quickVariantSelection of the table." }, "beforeRebindTable": { "type": "string", "description": "Before a table rebind, an event is triggered that contains information about the binding.\nThe event contains a parameter, `collectionBindingInfo`, which is an instance of `CollectionBindingInfoAPI`.\nIt can also contain an optional parameter, `quickFilterKey`, which indicates what is the quick filter key (if any) being processed for the table.\nThis allows you to manipulate the table's list binding.\nYou can use this event to attach event handlers to the table's list binding.\nYou can use this event to add selects, and add or read the sorters and filters.\n", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "rowPress": { "type": "string", "description": "An event is triggered when the user chooses a row. The event contains information about which row is chosen.\nYou can set this to handle the navigation manually.\n", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "selectionChange": { "type": "string", "description": "An event triggered when the selection in the table changes.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control", "defaultAggregation": "columns" } }, "sap.fe.macros.TreeTable": { "description": "Building block used to create a tree table based on the metadata provided by OData V4.\nOverview of Tree Table Building Block\n\t\t\t", "isViewNode": true, "type": "object", "properties": { "busy": { "type": "boolean", "description": "An expression that allows you to control the 'busy' state of the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "condensedTableLayout": { "type": "boolean", "description": "Determines whether the table adapts to the condensed layout.", "artifactType": "XMLProperty", "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.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "disableColumnFreeze": { "type": "boolean", "description": "Determines whether the number of fixed columns can be configured in the Column Settings dialog.\nThis property doesn't apply for responsive tables\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "disableCopyToClipboard": { "type": "boolean", "description": "Controls if the copy functionality of the table is disabled or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableAutoColumnWidth": { "type": "boolean", "description": "Specifies if the column width is automatically calculated.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableExport": { "type": "boolean", "description": "Controls if the export functionality of the table is enabled or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableFullScreen": { "type": "boolean", "description": "Controls whether the table can be opened in full-screen mode or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enablePaste": { "type": "boolean", "description": "Controls if the paste functionality of the table is enabled or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enablePastingOfComputedProperties": { "type": "boolean", "description": "Determine whether the data copied to the computed columns is sent to the back end.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableSelectAll": { "type": "boolean", "description": "Determines whether the Clear All button is enabled by default.\nTo enable the Clear All button by default, you must set this property to false.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "exportFileName": { "type": "string", "description": "Configures the file name of exported table.\nIt's limited to 31 characters. If the name is longer, it is truncated.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "exportRequestSize": { "type": "number", "description": "Maximum allowed number of records to be exported in one request.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "exportSheetName": { "type": "string", "description": "Configures the sheet name of exported table.\nIt's limited to 31 characters. If the name is longer, it is truncated.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "filterBar": { "type": "string", "description": "ID of the FilterBar building block associated with the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "frozenColumnCount": { "type": "number", "description": "Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.\nThis property is not relevant for responsive tables\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "header": { "type": "string", "description": "Specifies the header text that is shown in the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "headerVisible": { "type": "boolean", "description": "Controls if the header text should be shown or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "hierarchyQualifier": { "type": "string", "description": "The hierarchy qualifier used in the RecursiveHierarchy annotation.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "ignoredFields": { "type": "string", "description": "Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.\nThe table building block is not going to create built-in columns or offer table personalization for comma-separated value of fields that are provided in the ignoredfields.\nAny column referencing an ignored field is to be removed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isCopyToPositionAllowed": { "type": "string", "description": "Defines the extension point to control whether a source node can be copied to a specific parent node.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isMoveToPositionAllowed": { "type": "string", "description": "Defines the extension point to control whether a source node can be dropped on a specific parent node.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isNodeCopyable": { "type": "string", "description": "Defines the extension point to control whether a node can be copied.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isNodeMovable": { "type": "string", "description": "Defines the extension point to control if a node can be dragged.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isSearchable": { "type": "boolean", "description": "Defines whether to display the search action.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Defines the relative path to a LineItem, PresentationVariant, or SelectionPresentationVariant in the metamodel, based on the current contextPath.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "modeForNoDataMessage": { "type": "string", "description": "Changes the size of the IllustratedMessage in the table, or removes it completely.\nAllowed values are `illustratedMessage-Auto`, `illustratedMessage-Base`, `illustratedMessage-Dialog`, `illustratedMessage-Dot`, `illustratedMessage-Scene`, `illustratedMessage-Spot` or `text`.", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "illustratedMessage-Auto", "illustratedMessage-Base", "illustratedMessage-Medium", "illustratedMessage-Dot", "illustratedMessage-ExtraSmall", "illustratedMessage-Scene", "illustratedMessage-Large", "illustratedMessage-Spot", "illustratedMessage-Small", "text" ] }, "personalization": { "type": "string", "description": "Controls which options should be enabled for the table personalization dialog.\nIf 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- Group\n\nThe Group option is only applicable to analytical tables and responsive tables.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "popinLayout": { "type": "string", "description": "Defines the layout options of the table popins. Only applies to responsive tables.\nAllowed values are `Block`, `GridLarge`, and `GridSmall`.\n- `Block`: Sets a block layout for rendering the table popins. The elements inside the popin container are rendered one below the other.\n- `GridLarge`: Sets a grid layout for rendering the table popins. The grid width for each table popin is comparatively larger than GridSmall, so this layout allows less content to be rendered in a single popin row.\n- `GridSmall`: Sets a grid layout for rendering the table popins. The grid width for each table popin is small, so this layout allows more content to be rendered in a single popin row.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Block", "GridLarge", "GridSmall" ] }, "readOnly": { "type": "boolean", "description": "An expression that allows you to control the 'read-only' state of the table.\nIf you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "rowCount": { "type": "number", "description": "Number of rows to be displayed in the table. Does not apply to responsive tables.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "rowCountMode": { "type": "string", "description": "Defines how the table handles the visible rows. Does not apply to responsive tables.\nAllowed values are `Auto`, `Fixed`, and `Interactive`.\n- If set to `Fixed`, the table always has as many rows as defined in the rowCount property.\n- If set to `Auto`, the number of rows is changed by the table automatically. The table adjusts the number of rows based on the available space, which is limited by the surrounding container. The table cannot have fewer rows than defined in the `rowCount` property.\n- If set to `Interactive` the table can have as many rows as defined in the rowCount property. The number of rows can be modified by dragging the resizer.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Auto", "Fixed", "Interactive" ] }, "scrollThreshold": { "type": "number", "description": "Defines how many additional data records are requested from the back-end system when the user scrolls vertically in the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "selectionLimit": { "type": "number", "description": "Defines the maximum number of rows that can be selected at once in the table.\nThis property does not apply to responsive tables.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "selectionMode": { "type": "string", "description": "Defines the selection mode to be used by the table.\nAllowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti`, or `Auto`.\nIf set to `Single`, `Multi`, or `Auto`, SAP Fiori elements hooks into the standard lifecycle to determine a consistent selection mode.\nIf set to `ForceSingle` or `ForceMulti`, note this may not adhere to the SAP Fiori guidelines.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "None", "Single", "Multi", "Auto", "ForceMulti", "ForceSingle" ] }, "threshold": { "type": "number", "description": "Defines the number of records to be initially requested from the back end.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "type": { "type": "string", "description": "Defines the type of table that will be used by the building block to render the data. This setting is defined by the framework.\nAllowed value is `TreeTable`.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "const": "TreeTable" }, "variantManagement": { "type": "string", "description": "Controls the kind of variant management that should be enabled for the table.\nAllowed value is `Control`.\nIf set with value `Control`, a variant management control is seen within the table and the table is linked to this.\nIf not set with any value, control level variant management is not available for this table.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "", "Control" ] }, "widthIncludingColumnHeader": { "type": "boolean", "description": "Indicates if the column header should be a part of the width calculation.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "creationMode": { "$ref": "#/definitions/sap.fe.macros.table.TreeTableCreationOptions", "description": "A set of options that can be configured.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "actionOverflowGroups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.OverflowGroup" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "actions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.Action" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "analyticalConfiguration": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.AnalyticalConfiguration" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "A set of options that can be configured to control the aggregation behavior" }, "columns": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.Column" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "massEdit": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.MassEdit" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "Aggregate mass edit of the table." }, "quickVariantSelection": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.QuickVariantSelection" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "Aggregate quickVariantSelection of the table." }, "beforeRebindTable": { "type": "string", "description": "Before a table rebind, an event is triggered that contains information about the binding.\nThe event contains a parameter, `collectionBindingInfo`, which is an instance of `CollectionBindingInfoAPI`.\nIt can also contain an optional parameter, `quickFilterKey`, which indicates what is the quick filter key (if any) being processed for the table.\nThis allows you to manipulate the table's list binding.\nYou can use this event to attach event handlers to the table's list binding.\nYou can use this event to add selects, and add or read the sorters and filters.\n", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "rowPress": { "type": "string", "description": "An event is triggered when the user chooses a row. The event contains information about which row is chosen.\nYou can set this to handle the navigation manually.\n", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "selectionChange": { "type": "string", "description": "An event triggered when the selection in the table changes.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.VariantManagement": { "description": "Building block used to create a Variant Management based on the metadata provided by OData V4.\nUsage example:\n\n<macro:VariantManagement\nid=\"SomeUniqueIdentifier\"\nfor=\"{listOfControlIds>}\"\n/>\n\nOverview of Building Blocks\n\t\t\t\n", "isViewNode": true, "type": "object", "properties": { "headerLevel": { "type": "string", "description": "Header level for the variant management, determining its position or style.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "any", "description": "Identifier for the variant management control.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showSetAsDefault": { "type": "boolean", "description": "Whether the \"Set as Default\" option is visible.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.chart.Action": { "description": "Definition of a custom action to be used in the chart toolbar", "isViewNode": true, "type": "object", "properties": { "press": { "type": "string", "description": "Event handler to be called when the user chooses the action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "requiresSelection": { "type": "boolean", "description": "Defines if the action requires a selection.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "anchor": { "type": "string", "description": "Reference to the key of another action already displayed in the toolbar to properly place this one", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enabled": { "type": "any", "description": "Enables or disables the action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "group": { "type": "number", "description": "Defines the group of the action in the overflow toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isAIOperation": { "type": "boolean", "description": "Displays the AI Icon on the action button.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "key": { "type": "string", "description": "Unique identifier of the action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "overflowGroup": { "type": "number", "description": "Defines the overflow group of the action in the overflow toolbar.\nTakes precedence over the group property when defined.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "placement": { "type": "string", "description": "Defines where this action is placed relative to the defined anchor\nAllowed values are `Before` and `After`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "After", "Before" ] }, "priority": { "type": "string", "description": "Defines the priority of the action in the overflow toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "text": { "type": "string", "description": "The text that is to be displayed for this action", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "i18nClassification": "BUT: Text of the action button" }, "visible": { "type": "boolean", "description": "Determines whether the action is visible.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.chart.ActionGroup": { "description": "Definition of a custom action group to be used inside the chart toolbar", "isViewNode": true, "type": "object", "properties": { "anchor": { "type": "string", "description": "Reference to the key of another action or action group already displayed in the toolbar to properly place this one", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "key": { "type": "string", "description": "Unique identifier of the action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "overflowGroup": { "type": "number", "description": "Defines the overflow group of the action in the overflow toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "placement": { "type": "string", "description": "Defines where this action group should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "After", "Before" ] }, "text": { "type": "string", "description": "The text that will be displayed for this action group", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "i18nClassification": "BUT: Text of the action group button" }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "press": { "type": "string", "description": "Event handler to be called when the user chooses the action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "requiresSelection": { "type": "boolean", "description": "Defines if the action requires a selection.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enabled": { "type": "any", "description": "Enables or disables the action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "group": { "type": "number", "description": "Defines the group of the action in the overflow toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isAIOperation": { "type": "boolean", "description": "Displays the AI Icon on the action button.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "priority": { "type": "string", "description": "Defines the priority of the action in the overflow toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "visible": { "type": "boolean", "description": "Determines whether the action is visible.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "actions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.chart.Action" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control", "defaultAggregation": "actions" } }, "sap.fe.macros.chart.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.\nUsage example:\n\nsap.ui.require([\"sap/fe/macros/chart/Chart\"], function(Chart) {\n\t ...\n\t new Chart(\"myChart\", {metaPath:\"MyChart\"})\n})\n\nThis is currently an experimental API because the structure of the generated content will change to come closer to the Chart that you get out of templates.\nThe public method and property will not change but the internal structure will so be careful on your usage.\n", "isViewNode": true, "type": "object", "properties": { "contextPath": { "type": "string", "description": "Metadata path to the entitySet or navigationProperty", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "header": { "type": "string", "description": "Specifies the header text that is shown in the chart", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "headerVisible": { "type": "boolean", "description": "Controls if the header text should be shown or not", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Metadata path to the presentation context (UI.Chart with or without a qualifier)", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "personalization": { "type": "string", "description": "Controls which options should be enabled for the chart personalization dialog.\nIf it is set to `true`, all possible options for this kind of chart 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- Type\n- Item\n- Filter\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "selectionMode": { "type": "string", "description": "Defines the selection mode to be used by the chart.\nAllowed values are `None`, `Single` or `Multiple`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "None", "Single", "Multiple" ] }, "variantManagement": { "type": "string", "description": "Controls the kind of variant management that should be enabled for the chart.\nAllowed value is `Control`.\nIf set with value `Control`, a variant management control is seen within the chart and the chart is linked to this.\nIf not set with any value, variant management control is not available for this chart.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "", "Control" ] }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "actionOverflowGroups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.chart.OverflowGroup" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "actions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.chart.Action" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "selectionChange": { "type": "string", "description": "An event triggered when chart selections are changed. The event contains information about the data selected/deselected and the Boolean flag that indicates whether data is selected or deselected.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.chart.OverflowGroup": { "description": "Definition of an overflow group to be used in the chart toolbar", "isViewNode": true, "type": "object", "properties": { "overflowGroup": { "type": "number", "description": "Defines the group of the toolbar separator in the overflow toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showSeparator": { "type": "boolean", "description": "Defines if a toolbar separator should be displayed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.controls.BaseAction": { "description": "Base class for Action building blocks used across different UI areas, such as Table and Chart.\nContains common properties shared by all action types.", "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", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enabled": { "type": "any", "description": "Enables or disables the action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "group": { "type": "number", "description": "Defines the group of the action in the overflow toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isAIOperation": { "type": "boolean", "description": "Displays the AI Icon on the action button.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "key": { "type": "string", "description": "Unique identifier of the action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "overflowGroup": { "type": "number", "description": "Defines the overflow group of the action in the overflow toolbar.\nTakes precedence over the group property when defined.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "placement": { "type": "string", "description": "Defines where this action is placed relative to the defined anchor\nAllowed values are `Before` and `After`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "After", "Before" ] }, "priority": { "type": "string", "description": "Defines the priority of the action in the overflow toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "requiresSelection": { "type": "boolean", "description": "Defines if the action requires a selection.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "text": { "type": "string", "description": "The text that is to be displayed for this action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "visible": { "type": "boolean", "description": "Determines whether the action is visible.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.controls.BuildingBlockObjectProperty": { "description": "Base class for building block complex object properties that can be serialized to XML.", "isViewNode": true, "type": "object", "properties": { "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.controls.BuildingBlockWithTemplating": { "description": "Using this class you can define a building block that will manage and render a templating based building block.\nOn change of the main properties you will be able to recreate the content.", "isViewNode": true, "type": "object", "properties": { "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.FlexibleColumnLayoutActions": { "description": "Building block for adding overflow toolbar buttons to integrate into the flexible column layout support from Fiori elements.\nUsage example:\n\n<macros:FlexibleColumnLayoutActions />\n\n", "isViewNode": true, "type": "object", "properties": { "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.field.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.\nWhen creating a Field building block, you must provide an ID to ensure everything works correctly.\nUsage example:\n\nsap.ui.require([\"sap/fe/macros/field/Field\"], function(Field) {\n\t ...\n\t new Field(\"MyField\", {metaPath:\"MyProperty\"})\n})\n\nThis is currently an experimental API because the structure of the generated content will change to come closer to the Field that you get out of templates.\nThe public method and property will not change but the internal structure will so be careful on your usage.\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.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "description": { "type": "string", "description": "This is used to optionally provide an external description that comes from a different model than the oData model.\nThis should be used in conjunction with the value property.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "readOnly": { "type": "boolean", "description": "An expression that allows you to control the read-only state of the field.\nIf you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "semanticObject": { "type": "string", "description": "Option to add semantic objects for a field.\nThis parameter overwrites the semantic objects defined through annotations.\nValid options are either a single semantic object, a stringified array of semantic objects,\na formatter or a single binding expression returning either a single semantic object or an array of semantic objects.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "value": { "type": "string", "description": "This is used to optionally provide an external value that comes from a different model than the OData model.\nIt is designed to work with a field with value help, and without support for complex value help (currency / unit).", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "formatOptions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.field.FieldFormatOptions" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "A set of options that can be configured." }, "change": { "type": "string", "description": "An event containing details is triggered when the value of the field is changed.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "liveChange": { "type": "string", "description": "An event containing details is triggered when the value of the field is live changed.\nNote: Browsing autocomplete suggestions does not fire the event.\n", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.field.FieldFormatOptions": { "description": "Additional format options for the field.", "isViewNode": false, "type": "object", "properties": { "dateTimePattern": { "type": "string", "description": "Property for defining a custom pattern for the date, time, or dateTime format. \nIf a dateTimePattern is defined, the dateTimeStyle is ignored.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "dateTimeStyle": { "type": "string", "description": "Property for defining the display style for the date, time, or dateTime format. \nIf there is a dateTimePattern defined, dateTimeStyle is ignored.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "short", "medium", "long", "full" ] }, "displayMode": { "type": "string", "description": "Defines how the field value and associated text will be displayed together.\n\nAllowed values are \"Value\", \"Description\", \"DescriptionValue\" and \"ValueDescription\"\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Description", "DescriptionValue", "Value", "ValueDescription" ] }, "enableEnlargeImage": { "type": "boolean", "description": "Property for defining if the avatar image can be enlarged.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "fieldEditStyle": { "type": "string", "description": "Determines how the field should be rendered, e.g. as radio buttons. \nIf not all prerequisites are met, the field will default back to the standard rendering.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "RadioButtons", "" ] }, "hasSituationsIndicator": { "type": "boolean", "description": "Indicates whether the field has a situations indicator.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "imageFitType": { "type": "string", "description": "Property for defining how the avatar image fits within the given dimensions.", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Cover", "Contain" ] }, "measureDisplayMode": { "type": "string", "description": "Defines if and how the field measure will be displayed.\n\nAllowed values are \"Hidden\" and \"ReadOnly\"\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Hidden", "ReadOnly" ] }, "radioButtonsHorizontalLayout": { "type": "boolean", "description": "Specifies if radio buttons should be rendered in a horizontal layout. \n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "reactiveAreaMode": { "type": "string", "description": "When the Field is displayed as a clickable element, it defines the size of the reactive area of the clickable element:\n- ReactiveAreaMode.Inline - The link is displayed as part of a sentence.\n- ReactiveAreaMode.Overlay - The link is displayed as an overlay on top of other interactive parts of the page.\nNote: It is designed to make the clickable element easier to activate and helps meet the WCAG 2.2 Target Size requirement. It is applicable only for the SAP Horizon themes. Note: The size of the reactive area is sufficiently large to help users avoid accidentally selecting (clicking or tapping) unintended UI elements. UI elements positioned over other parts of the page may need an invisible active touch area. This ensures that no elements beneath are activated accidentally when the user tries to interact with the overlay element.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Inline", "Overlay" ] }, "showDate": { "type": "boolean", "description": "Defines if the date part of a date time with timezone field should be shown. \n\nThe dateTimeOffset field must have a timezone annotation.\nThe default value is true.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showTime": { "type": "boolean", "description": "Defines if the time part of a date time with timezone field should be shown. \n\nThe dateTimeOffset field must have a timezone annotation.\nThe default value is true.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showTimezone": { "type": "boolean", "description": "Defines if the timezone part of a date time with timezone field should be shown. \n\nThe dateTimeOffset field must have a timezone annotation.\nThe default value is true.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "textExpandBehaviorDisplay": { "type": "string", "description": "Defines how the full text will be displayed.\n\nAllowed values are \"InPlace\" and \"Popover\"\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "InPlace", "Popover" ] }, "textLinesEdit": { "type": "number", "description": "Maximum number of lines for multiline texts in edit mode.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "textMaxCharactersDisplay": { "type": "number", "description": "Maximum number of characters from the beginning of the text field that are shown initially.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "textMaxLength": { "type": "number", "description": "Defines the maximum number of characters for the multiline text value.\n\nIf a multiline text exceeds the maximum number of allowed characters, the counter below the input field displays the exact number.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "textMaxLines": { "type": "number", "description": "Maximum number of lines that multiline texts in edit mode can grow to.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.filterBar.FilterBar": { "description": "Usage example:\n\nsap.ui.require([\"sap/fe/macros/filterBar/FilterBar\"], function(FilterBar) {\n\t ...\n\t new FilterBar(\"MyFilterBar\", {metaPath:\"@com.sap.vocabularies.UI.v1.SelectionFields\"})\n})\n\nThis is currently an experimental API because the structure of the generated content will change to come closer to the FilterBar that you get out of templates.\nThe public method and property will not change but the internal structure will so be careful on your usage.\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.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "liveMode": { "type": "boolean", "description": "If true, the search is triggered automatically when a filter value is changed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "navigationPropertiesForPersonalization": { "$ref": "#/definitions/string[]", "description": "Comma separated list of navigation properties which are considered for filtering.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showClearButton": { "type": "boolean", "description": "Handles the visibility of the 'Clear' button on the FilterBar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showMessages": { "type": "boolean", "description": "Displays possible errors during the search in a message box", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "visible": { "type": "boolean", "description": "Parameter which sets the visibility of the FilterBar building block", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "filterFields": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.filterBar.FilterField" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "afterClear": { "type": "string", "description": "This event is fired when the 'Clear' button is pressed. This is only possible when the 'Clear' button is enabled.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "filterChanged": { "type": "string", "description": "This event is fired after either a filter value or the visibility of a filter item has been changed. The event contains conditions that are used as filters.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "search": { "type": "string", "description": "This event is fired when the 'Go' button is pressed or after a condition change.", "artifactType": "XMLProperty", "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.\nOverview of Building Blocks\n\t\t\t\n\nUsually, a SelectionFields annotation is expected.\nUsage example:\n\n<macros: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.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "liveMode": { "type": "boolean", "description": "If true, the search is triggered automatically when a filter value is changed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "navigationPropertiesForPersonalization": { "$ref": "#/definitions/string[]", "description": "Comma separated list of navigation properties which are considered for filtering.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showClearButton": { "type": "boolean", "description": "Handles the visibility of the 'Clear' button on the FilterBar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showMessages": { "type": "boolean", "description": "Displays possible errors during the search in a message box", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "visible": { "type": "boolean", "description": "Parameter which sets the visibility of the FilterBar building block", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "filterFields": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.filterBar.FilterField" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "afterClear": { "type": "string", "description": "This event is fired when the 'Clear' button is pressed. This is only possible when the 'Clear' button is enabled.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "filterChanged": { "type": "string", "description": "This event is fired after either a filter value or the visibility of a filter item has been changed. The event contains conditions that are used as filters.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "search": { "type": "string", "description": "This event is fired when the 'Go' button is pressed or after a condition change.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.filterBar.FilterField": { "description": "Definition of a custom filter to be used inside the FilterBar.\nThe template for the FilterField has to be provided as the default aggregation\nOverview of Building Blocks\n\t\t\t\n", "isViewNode": true, "type": "object", "properties": { "anchor": { "type": "string", "description": "Reference to the key of another filter already displayed in the table to properly place this one", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "availability": { "type": "string", "description": "The filter field availability.\nAllowed values are `Default`, `Adaptation`, and `Hidden`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "key": { "type": "string", "description": "The property name of the FilterField", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "label": { "type": "string", "description": "The text that will be displayed for this FilterField", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "placement": { "type": "string", "description": "Defines where this filter should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "After", "Before" ] }, "property": { "type": "string", "description": "Defines which property are influenced by the FilterField.\nThis must be a valid property of the entity as this can be used for SAP Companion integration\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "required": { "type": "boolean", "description": "If set, the FilterField will be marked as a mandatory field.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showMessages": { "type": "boolean", "description": "This property is not required at filter field level. To achieve the desired behavior, specify the showMessages property in the FilterBar building block.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.filterBar.FilterFieldOverride": { "description": "Definition of an override for the filter field to be used inside the FilterBar building block.", "isViewNode": true, "type": "object", "properties": { "anchor": { "type": "string", "description": "Reference to the key of another filter already displayed in the table to properly place this one.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "availability": { "type": "string", "description": "The filter field availability.\nAllowed values are `Default`, `Adaptation`, and `Hidden`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "key": { "type": "string", "description": "Unique identifier of the filter field to be overridden.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "placement": { "type": "string", "description": "Defines where this filter is placed relative to the defined anchor.\nAllowed values are `Before` and `After`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "After", "Before" ] }, "required": { "type": "boolean", "description": "If set, the FilterField is marked as a mandatory field.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.Form": { "description": "Building block for creating a Form based on the metadata provided by OData V4.\n\nIt is designed to work based on a FieldGroup annotation but can also work if you provide a ReferenceFacet or a CollectionFacet\nUsage example:\n\n<macros:Form id=\"MyForm\" metaPath=\"@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation\" />\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.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "layout": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.form.FormLayoutOptions" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "Defines the layout to be used within the form.\nIt defaults to the ColumnLayout, but you can also use a ResponsiveGridLayout.\nAll the properties of the ResponsiveGridLayout can be added to the configuration." }, "metaPath": { "type": "string", "description": "Defines the relative path of the property in the metamodel, based on the current contextPath.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "navigationPropertiesForAdaptationDialog": { "$ref": "#/definitions/string[]", "description": "Filters the navigation properties that can be used by flexibility features.\nThis property allows you to specify which navigation properties are available\nfor flexibility operations such as adding custom fields.\nYou can use the asterisk (*) wildcard to include all navigation properties,\nor specify individual navigation property names to restrict the available options.\nExample:\nAllow all navigation properties: navigationPropertiesForAdaptationDialog: [\"*\"]\nExample:\nAllow only a specific navigation property: navigationPropertiesForAdaptationDialog: [\"Customer/Name\"]\nExample:\nAllow multiple specific navigation properties based on a wildcard: navigationPropertiesForAdaptationDialog: [\"Cust*\\/Name\"]", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "title": { "type": "string", "description": "The title of the form control.", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "i18nClassification": "HED: Title of the form" }, "visible": { "type": "boolean", "description": "Parameter which sets the visibility of the Form building block", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "fields": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.FormElement" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control", "defaultAggregation": "fields" } }, "sap.fe.macros.form.FormLayoutOptions": { "description": "Configuration options for the Form layout", "isViewNode": false, "type": "object", "properties": { "adjustLabelSpan": { "type": "boolean", "description": "If set, the usage of `labelSpanL` and `labelSpanXL` is dependent on the size of the used column.\nIf the space is less than 600px (e.g., 2 columns are used), `labelSpanM` is used instead.\nApplicable for ResponsiveGridLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "backgroundDesign": { "type": "string", "description": "Defines the background color of the form", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "breakpointL": { "type": "number", "description": "The breakpoint (in pixels) between L size and XL size for the ResponsiveGridLayout\nApplicable for ResponsiveGridLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "breakpointM": { "type": "number", "description": "The breakpoint (in pixels) between M size and L size for the ResponsiveGridLayout\nApplicable for ResponsiveGridLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "breakpointXL": { "type": "number", "description": "The breakpoint (in pixels) between XL size and XXL size for the ResponsiveGridLayout\nApplicable for ResponsiveGridLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "columnsL": { "type": "number", "description": "Number of columns for L size\nApplicable for ColumnLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "columnsM": { "type": "number", "description": "Number of columns for M size\nApplicable for ColumnLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "columnsXL": { "type": "number", "description": "Number of columns for XL size\nApplicable for ColumnLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "emptyCellsLarge": { "type": "number", "description": "Number of grid cells that are empty at the end of a row in large screen size\nApplicable for ColumnLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "emptySpanL": { "type": "number", "description": "Number of empty grid cells that are added on the end of each line in L size\nApplicable for ResponsiveGridLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "emptySpanM": { "type": "number", "description": "Number of empty grid cells that are added on the end of each line in M size\nApplicable for ResponsiveGridLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "emptySpanS": { "type": "number", "description": "Number of empty grid cells that are added on the end of each line in S size\nApplicable for ResponsiveGridLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "emptySpanXL": { "type": "number", "description": "Number of empty grid cells that are added on the end of each line in XL size\nApplicable for ResponsiveGridLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "labelCellsLarge": { "type": "number", "description": "Number of grid cells that are reserved for the labels in large screen size\nApplicable for ColumnLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "labelSpanL": { "type": "number", "description": "Number of grid cells that are used for the labels in L size\nApplicable for ResponsiveGridLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "labelSpanM": { "type": "number", "description": "Number of grid cells that are used for the labels in M size\nApplicable for ResponsiveGridLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "labelSpanS": { "type": "number", "description": "Number of grid cells that are used for the labels in S size\nApplicable for ResponsiveGridLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "labelSpanXL": { "type": "number", "description": "Number of grid cells that are used for the labels in XL size\nApplicable for ResponsiveGridLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "singleContainerFullSize": { "type": "boolean", "description": "If set, a single container has the full size of the parent container.\nOtherwise, the container size is determined by the number of columns and the spacing between the columns.\nApplicable for ResponsiveGridLayout type\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "type": { "type": "string", "description": "The layout type to be used for the form", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "ColumnLayout", "ResponsiveGridLayout" ] }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.microchart.MicroChart": { "description": "Building block used to create a MicroChart based on the metadata provided by OData V4.\n\nUsually, a contextPath and metaPath is expected.\nUsage example:\n\nsap.ui.require([\"sap/fe/macros/microchart/MicroChart\"], function(MicroChart) {\n\t ...\n\t new MicroChart(\"microChartID\", {metaPath:\"MyProperty\"})\n})\n\nThis is currently an experimental API because the structure of the generated content will change to come closer to the MicroChart that you get out of templates.\nThe public method and property will not change but the internal structure will so be careful on your usage.\n", "isViewNode": true, "type": "object", "properties": { "contextPath": { "type": "string", "description": "context path to the MicroChart.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "hideOnNoData": { "type": "boolean", "description": "Show blank space in case there is no data in the chart", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "linkAriaText": { "type": "string", "description": "Custom ARIA text for the title link.\nThis property is only used when titleAsLink is set to true.\nIf not provided, default ARIA text based on the navigationType is used.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Metadata path to the MicroChart.", "artifactType": "XMLProperty", "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\nnot see the inner labels of the MicroChart as well.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "size": { "type": "string", "description": "Size of the MicroChart", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "XS", "S", "M", "L" ] }, "titleAsLink": { "type": "boolean", "description": "Determines whether the micro chart title is displayed as a link or as a text.\nWhen set to true, the title is rendered as a clickable link.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "titlePress": { "type": "string", "description": "Event fired when the micro chart title link is pressed.\nThe event provides the binding context of the micro chart in the event parameters.\nThis event is only fired when titleAsLink is set to true.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.richtexteditor.ButtonGroup": { "description": "Button configurations for the RichTextEditor.", "isViewNode": true, "type": "object", "properties": { "buttons": { "type": "string", "description": "The buttons to be displayed in the group.", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "bold", "italic", "underline", "strikethrough", "fontfamily", "fontsize", "forecolor", "backcolor", "cut", "copy", "paste", "bullist", "numlist", "outdent", "indent", "undo", "redo", "image", "emoticons", "link", "unlink", "alignleft", "aligncenter", "alignright", "alignjustify", "table", "styleselect" ], "multiSelect": true }, "customToolbarPriority": { "type": "number", "description": "The priority of the group in the custom toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "name": { "type": "string", "description": "The name of the group.", "artifactType": "XMLProperty", "disabled": true, "metadata": { "type": "Property" }, "enum": [ "font-style", "font", "clipboard", "structure", "undo", "insert", "link", "text-align", "table", "styleselect" ] }, "priority": { "type": "number", "description": "The priority of the group.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "row": { "type": "number", "description": "Row number in which the button should be", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "visible": { "type": "boolean", "description": "Whether the group is visible.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "hidden": true, "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.richtexteditor.Plugin": { "description": "Represents a TinyMCE plugin.\nEach object has to contain a property \"name\" which then contains the plugin name/ID.", "isViewNode": true, "type": "object", "properties": { "name": { "type": "string", "description": "The plugin name.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.share.ShareOptions": { "description": "Share Options.", "isViewNode": false, "type": "object", "properties": { "showShareInWorkzone": { "type": "boolean", "description": "Controls visibility of the \"Share in SAP Build Work Zone\" option.\nThis option appears as either \"Share in SAP Jam\" or \"Share in SAP Build Work Zone\"\ndepending on the customer's deployment. Both labels refer to the same functionality.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "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": { "command": { "type": "string", "description": "Determines the shortcut combination to trigger the action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableOnSelect": { "type": "string", "description": "Determines whether the action requires selecting one item or multiple items.\nAllowed values are `single` and `multi`", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "multi", "single" ] }, "enabled": { "type": "boolean", "description": "Enables or disables the action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "requiresSelection": { "type": "boolean", "description": "Defines if the action requires a selection.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "visible": { "type": "boolean", "description": "Determines whether the action is visible.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "anchor": { "type": "string", "description": "Reference to the key of another action already displayed in the toolbar to properly place this one", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "group": { "type": "number", "description": "Defines the group of the action in the overflow toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isAIOperation": { "type": "boolean", "description": "Displays the AI Icon on the action button.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "key": { "type": "string", "description": "Unique identifier of the action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "overflowGroup": { "type": "number", "description": "Defines the overflow group of the action in the overflow toolbar.\nTakes precedence over the group property when defined.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "placement": { "type": "string", "description": "Defines where this action is placed relative to the defined anchor\nAllowed values are `Before` and `After`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "After", "Before" ] }, "priority": { "type": "string", "description": "Defines the priority of the action in the overflow toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "text": { "type": "string", "description": "The text that is to be displayed for this action", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "i18nClassification": "BUT: Text of the action button" }, "press": { "type": "string", "description": "Event handler to be called when the user chooses the action", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.table.ActionGroup": { "description": "Definition of a custom ActionGroup to be used inside the table toolbar", "isViewNode": true, "type": "object", "properties": { "anchor": { "type": "string", "description": "Reference to the key of another action or action group already displayed in the toolbar to properly place this one", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "defaultAction": { "type": "string", "description": "Determines the default action to be executed on the action group.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "key": { "type": "string", "description": "Unique identifier of the ActionGroup", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "overflowGroup": { "type": "number", "description": "Defines the overflow group of the action in the overflow toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "placement": { "type": "string", "description": "Determines where this action group should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "After", "Before" ] }, "priority": { "type": "string", "description": "Defines the priority of the action in the overflow toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "text": { "type": "string", "description": "The text that will be displayed for this action group", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "i18nClassification": "BUT: Text of the action group button" }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "actions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.Action" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control", "defaultAggregation": "actions" } }, "sap.fe.macros.table.ActionGroupOverride": { "description": "Definition of an action group override to be used inside the Table building block.", "isViewNode": true, "type": "object", "properties": { "anchor": { "type": "string", "description": "Reference to the key of another action or action group already displayed in the toolbar to properly place this one", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "key": { "type": "string", "description": "Unique identifier of the ActionGroup to overridden.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "placement": { "type": "string", "description": "Determines where this action group should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "After", "Before" ] }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "actions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.Action" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control", "defaultAggregation": "actions" } }, "sap.fe.macros.table.ActionOverride": { "description": "Definition of an override for the action to be used inside the Table building block.", "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", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "command": { "type": "string", "description": "Determines the shortcut combination to trigger the action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "defaultValuesFunction": { "type": "string", "description": "Determines the function to get the default values of the action.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "disableStrictHandling": { "type": "boolean", "description": "Disables strict handling for this action.\nWhen true, the action does not use strict message handling.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableAutoScroll": { "type": "boolean", "description": "Determines if the auto scroll is enabled after executing the action.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableOnSelect": { "type": "string", "description": "Determines whether the action requires selecting one item or multiple items.\nAllowed values are `single` and `multi`", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "multi", "single" ] }, "enabled": { "type": "boolean", "description": "Enables or disables the action", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isAIOperation": { "type": "boolean", "description": "Displays the AI Icon on the action button.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "key": { "type": "string", "description": "Unique identifier of the action to overridden.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "navigateToInstance": { "type": "boolean", "description": "Determines whether there is a navigation after executing the action.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "placement": { "type": "string", "description": "Defines where this action should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "After", "Before" ] }, "visible": { "type": "boolean", "description": "Determines whether the action is visible.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.table.AnalyticalConfiguration": { "description": "A set of options that can be configured to control the aggregation behavior", "isViewNode": true, "type": "object", "properties": { "aggregationOnLeafLevel": { "type": "boolean", "description": "True if leaf level rows shall display aggregated data", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "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.\nThe 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", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "availability": { "type": "string", "description": "The column availability\nAllowed values are `Default`, `Adaptation`, `Hidden`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "disableExport": { "type": "boolean", "description": "Determines if the column should be excluded from the export.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "header": { "type": "string", "description": "The text that will be displayed for this column header", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "i18nClassification": "COL: Header of the column" }, "horizontalAlign": { "type": "string", "description": "Aligns the header as well as the content horizontally", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "importance": { "type": "string", "description": "Defines the column importance.\nYou can define which columns should be automatically moved to the pop-in area based on their importance\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "key": { "type": "string", "description": "Unique identifier of the column", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "placement": { "type": "string", "description": "Determines where this column should be placed relative to the defined anchor\nAllowed values are `Before` and `After`\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "After", "Before" ] }, "properties": { "$ref": "#/definitions/string[]", "description": "Determines the properties displayed in the column\nThe properties allow to export, sort, group, copy, and paste in the column\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "required": { "type": "boolean", "description": "Determines if the information in the column is required.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "tooltip": { "type": "string", "description": "Determines the text displayed for the column tooltip", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "width": { "type": "string", "description": "Determines the column's width.\nAllowed values are 'auto', 'value', and 'inherit', according to sap.ui.core.CSSSize\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "widthIncludingColumnHeader": { "type": "boolean", "description": "Indicates if the column header should be a part of the width calculation.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.table.ColumnExportSettings": { "description": "Definition of the export settings applied to a column within the table.", "isViewNode": true, "type": "object", "properties": { "falseValue": { "type": "string", "description": "Determines the text associated to a Boolean type with 'false' as value.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "label": { "type": "string", "description": "Determines the column header text.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "property": { "$ref": "#/definitions/string[]", "description": "Determines the properties of the column.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "template": { "type": "string", "description": "Determines a formatting template that supports indexed placeholders within curly brackets.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "textAlign": { "type": "string", "description": "Determines the alignment of the column of the cell contents.\nAvailable options are:\n- Left\n- Right\n- Center\n- Begin\n- End\n\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "trueValue": { "type": "string", "description": "Determines the text associated to a Boolean type with 'true' as value.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "type": { "type": "string", "description": "Determines the data type of the field", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "valueMap": { "type": "object", "description": "Determines the mapping object holding the values associated with a specific key.\nEnumeration type must be used when valueMap is provided.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "width": { "type": "number", "description": "Determines the width of the column in characters", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "wrap": { "type": "boolean", "description": "Determines if the content needs to be wrapped.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.table.ColumnOverride": { "description": "Definition of an override for the column to be used inside the Table building block.", "isViewNode": true, "type": "object", "properties": { "availability": { "type": "string", "description": "The column availability\nAllowed values are `Default`, `Adaptation`, `Hidden``\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "disableExport": { "type": "boolean", "description": "Determines if the column should be excluded from the export.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "horizontalAlign": { "type": "string", "description": "Aligns the header as well as the content horizontally", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "importance": { "type": "string", "description": "Defines the importance of the column.\nYou can define which columns should be automatically moved to the pop-in area based on their importance\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "key": { "type": "string", "description": "Unique identifier of the column to overridden.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "width": { "type": "string", "description": "Determines the column's width.\nAllowed values are 'auto', 'value', and 'inherit', according to sap.ui.core.CSSSize\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "widthIncludingColumnHeader": { "type": "boolean", "description": "Indicates if the column header should be a part of the width calculation.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "exportSettings": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.ColumnExportSettings" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "Determines the export settings for the column." } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.table.MassEdit": { "description": "Definition of the mass edit to be used inside the table.", "isViewNode": true, "type": "object", "properties": { "ignoredFields": { "$ref": "#/definitions/string[]", "description": "Defines the list of fields that should be ignored in the mass edit dialog", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "operationGroupingMode": { "type": "string", "description": "Defines the mode of the operation grouping to save the new values\nAllowed values are `ChangeSet` and `Isolated`", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "ChangeSet", "Isolated" ] }, "visibleFields": { "$ref": "#/definitions/string[]", "description": "Defines the list of fields that should be visible in the mass edit dialog", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "customContent": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.ui.layout.form.FormContainer" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "The custom form container that can be displayed at the top of the mass edit dialog" } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control", "defaultAggregation": "customContent" } }, "sap.fe.macros.table.OverflowGroup": { "description": "Configuration of toolbar separators to be used inside the table toolbar", "isViewNode": true, "type": "object", "properties": { "overflowGroup": { "type": "number", "description": "Defines the group of the toolbar separator in the overflow toolbar.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showSeparator": { "type": "boolean", "description": "Defines if a toolbar separator should be displayed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.table.QuickVariantSelection": { "description": "Definition of the quickVariantSelection to be used inside the table.", "isViewNode": true, "type": "object", "properties": { "paths": { "$ref": "#/definitions/string[]", "description": "Defines the list of paths pointing to the selection variants that should be used as quick filters", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "showCounts": { "type": "boolean", "description": "Defines whether the counts should be displayed next to the text", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.table.Table": { "description": "Building block used to create a table based on the metadata provided by OData V4.\n\nUsually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but the Table building block can also be used to display an EntitySet.\n\nIf a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.\n\nIf a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that also has a UI.LineItem as the first property of the Visualizations.\nUsage example:\n\nsap.ui.require([\"sap/fe/macros/table/Table\"], function(Table) {\n\t ...\n\t new Table(\"myTable\", {metaPath:\"@com.sap.vocabularies.UI.v1.LineItem\"})\n})\n\nThis is currently an experimental API because the structure of the generated content will change to come closer to the Table that you get out of templates.\nThe public method and property will not change but the internal structure will so be careful on your usage.\n", "isViewNode": true, "type": "object", "properties": { "busy": { "type": "boolean", "description": "An expression that allows you to control the 'busy' state of the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "condensedTableLayout": { "type": "boolean", "description": "Determines whether the table adapts to the condensed layout.", "artifactType": "XMLProperty", "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.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "disableColumnFreeze": { "type": "boolean", "description": "Determines whether the number of fixed columns can be configured in the Column Settings dialog.\nThis property doesn't apply for responsive tables\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "disableCopyToClipboard": { "type": "boolean", "description": "Controls if the copy functionality of the table is disabled or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableAutoColumnWidth": { "type": "boolean", "description": "Specifies if the column width is automatically calculated.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableExport": { "type": "boolean", "description": "Controls if the export functionality of the table is enabled or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableFullScreen": { "type": "boolean", "description": "Controls whether the table can be opened in full-screen mode or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enablePaste": { "type": "boolean", "description": "Controls if the paste functionality of the table is enabled or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enablePastingOfComputedProperties": { "type": "boolean", "description": "Determine whether the data copied to the computed columns is sent to the back end.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableSelectAll": { "type": "boolean", "description": "Determines whether the Clear All button is enabled by default.\nTo enable the Clear All button by default, you must set this property to false.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "exportFileName": { "type": "string", "description": "Configures the file name of exported table.\nIt's limited to 31 characters. If the name is longer, it is truncated.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "exportRequestSize": { "type": "number", "description": "Maximum allowed number of records to be exported in one request.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "exportSheetName": { "type": "string", "description": "Configures the sheet name of exported table.\nIt's limited to 31 characters. If the name is longer, it is truncated.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "filterBar": { "type": "string", "description": "ID of the FilterBar building block associated with the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "frozenColumnCount": { "type": "number", "description": "Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.\nThis property is not relevant for responsive tables\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "header": { "type": "string", "description": "Specifies the header text that is shown in the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "headerVisible": { "type": "boolean", "description": "Controls if the header text should be shown or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "ignoredFields": { "type": "string", "description": "Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.\nThe table building block is not going to create built-in columns or offer table personalization for comma-separated value of fields that are provided in the ignoredfields.\nAny column referencing an ignored field is to be removed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isSearchable": { "type": "boolean", "description": "Defines whether to display the search action.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Defines the relative path to a LineItem, PresentationVariant, or SelectionPresentationVariant in the metamodel, based on the current contextPath.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "modeForNoDataMessage": { "type": "string", "description": "Changes the size of the IllustratedMessage in the table, or removes it completely.\nAllowed values are `illustratedMessage-Auto`, `illustratedMessage-Base`, `illustratedMessage-Dialog`, `illustratedMessage-Dot`, `illustratedMessage-Scene`, `illustratedMessage-Spot` or `text`.", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "illustratedMessage-Auto", "illustratedMessage-Base", "illustratedMessage-Medium", "illustratedMessage-Dot", "illustratedMessage-ExtraSmall", "illustratedMessage-Scene", "illustratedMessage-Large", "illustratedMessage-Spot", "illustratedMessage-Small", "text" ] }, "personalization": { "type": "string", "description": "Controls which options should be enabled for the table personalization dialog.\nIf 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- Group\n\nThe Group option is only applicable to analytical tables and responsive tables.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "popinLayout": { "type": "string", "description": "Defines the layout options of the table popins. Only applies to responsive tables.\nAllowed values are `Block`, `GridLarge`, and `GridSmall`.\n- `Block`: Sets a block layout for rendering the table popins. The elements inside the popin container are rendered one below the other.\n- `GridLarge`: Sets a grid layout for rendering the table popins. The grid width for each table popin is comparatively larger than GridSmall, so this layout allows less content to be rendered in a single popin row.\n- `GridSmall`: Sets a grid layout for rendering the table popins. The grid width for each table popin is small, so this layout allows more content to be rendered in a single popin row.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Block", "GridLarge", "GridSmall" ] }, "readOnly": { "type": "boolean", "description": "An expression that allows you to control the 'read-only' state of the table.\nIf you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "rowCount": { "type": "number", "description": "Number of rows to be displayed in the table. Does not apply to responsive tables.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "rowCountMode": { "type": "string", "description": "Defines how the table handles the visible rows. Does not apply to responsive tables.\nAllowed values are `Auto`, `Fixed`, and `Interactive`.\n- If set to `Fixed`, the table always has as many rows as defined in the rowCount property.\n- If set to `Auto`, the number of rows is changed by the table automatically. The table adjusts the number of rows based on the available space, which is limited by the surrounding container. The table cannot have fewer rows than defined in the `rowCount` property.\n- If set to `Interactive` the table can have as many rows as defined in the rowCount property. The number of rows can be modified by dragging the resizer.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Auto", "Fixed", "Interactive" ] }, "scrollThreshold": { "type": "number", "description": "Defines how many additional data records are requested from the back-end system when the user scrolls vertically in the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "selectionLimit": { "type": "number", "description": "Defines the maximum number of rows that can be selected at once in the table.\nThis property does not apply to responsive tables.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "selectionMode": { "type": "string", "description": "Defines the selection mode to be used by the table.\nAllowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti`, or `Auto`.\nIf set to `Single`, `Multi`, or `Auto`, SAP Fiori elements hooks into the standard lifecycle to determine a consistent selection mode.\nIf set to `ForceSingle` or `ForceMulti`, note this may not adhere to the SAP Fiori guidelines.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "None", "Single", "Multi", "Auto", "ForceMulti", "ForceSingle" ] }, "threshold": { "type": "number", "description": "Defines the number of records to be initially requested from the back end.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "type": { "type": "string", "description": "Defines the type of table that is used by the building block to render data.\nAllowed values are `GridTable`, `ResponsiveTable`, and `AnalyticalTable`.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "GridTable", "ResponsiveTable", "AnalyticalTable" ] }, "variantManagement": { "type": "string", "description": "Controls the kind of variant management that should be enabled for the table.\nAllowed value is `Control`.\nIf set with value `Control`, a variant management control is seen within the table and the table is linked to this.\nIf not set with any value, control level variant management is not available for this table.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "", "Control" ] }, "widthIncludingColumnHeader": { "type": "boolean", "description": "Indicates if the column header should be a part of the width calculation.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "creationMode": { "$ref": "#/definitions/sap.fe.macros.table.TableCreationOptions", "description": "A set of options that can be configured.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "actionOverflowGroups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.OverflowGroup" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "actions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.Action" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "analyticalConfiguration": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.AnalyticalConfiguration" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "A set of options that can be configured to control the aggregation behavior" }, "columns": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.Column" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "massEdit": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.MassEdit" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "Aggregate mass edit of the table." }, "quickVariantSelection": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.QuickVariantSelection" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "Aggregate quickVariantSelection of the table." }, "beforeRebindTable": { "type": "string", "description": "Before a table rebind, an event is triggered that contains information about the binding.\nThe event contains a parameter, `collectionBindingInfo`, which is an instance of `CollectionBindingInfoAPI`.\nIt can also contain an optional parameter, `quickFilterKey`, which indicates what is the quick filter key (if any) being processed for the table.\nThis allows you to manipulate the table's list binding.\nYou can use this event to attach event handlers to the table's list binding.\nYou can use this event to add selects, and add or read the sorters and filters.\n", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "rowPress": { "type": "string", "description": "An event is triggered when the user chooses a row. The event contains information about which row is chosen.\nYou can set this to handle the navigation manually.\n", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "selectionChange": { "type": "string", "description": "An event triggered when the selection in the table changes.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.table.TableCreationOptions": { "description": "Create options for the table.", "isViewNode": false, "type": "object", "properties": { "createAtEnd": { "type": "boolean", "description": "Specifies if the new entry should be created at the top or bottom of a table in case of creationMode 'Inline'\nThe default value is 'false'\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "creationFields": { "type": "string", "description": "Defines the list of properties that will be displayed in the creation dialog, when the creation mode is set to 'CreationDialog'.\nThe value is a comma-separated list of property names.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "inlineCreationRowsHiddenInEditMode": { "type": "boolean", "description": "Specifies if the new entry should be hidden in case of creationMode 'InlineCreationRows'. This only applies to responsive tables.\nThe default value is 'false'\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "name": { "type": "string", "description": "Defines the creation mode to be used by the table.\nAllowed values are `NewPage`, `Inline`, `InlineCreationsRows`, `External` or `CreationDialog`.\n\nNewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async' or 'Deferred' is used\nInline - The creation is done inline\nInlineCreationsRows - The creation is done inline with an empty row\nExternal - The creation is done in a different application specified via the parameter 'outbound'\nCreationDialog - the creation is done in the table, with a dialog allowing to specify some initial property values (the properties are listed in `creationFields`).\n\nIf not set with any value:\nif navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "CreationDialog", "External", "Inline", "InlineCreationRows", "NewPage" ] }, "outbound": { "type": "string", "description": "The navigation target where the document is created in case of creationMode 'External'\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.table.TreeTable": { "description": "Building block used to create a table based on the metadata provided by OData V4.\n\nUsually, a LineItem, PresentationVariant or SelectionPresentationVariant annotation is expected, but the Table building block can also be used to display an EntitySet.\n\nIf a PresentationVariant is specified, then it must have UI.LineItem as the first property of the Visualizations.\n\nIf a SelectionPresentationVariant is specified, then it must contain a valid PresentationVariant that also has a UI.LineItem as the first property of the Visualizations.\nUsage example:\n\nsap.ui.require([\"sap/fe/macros/table/TreeTable\"], function(TreeTable) {\n\t ...\n\t new TreeTable(\"myTable\", {metaPath:\"@com.sap.vocabularies.UI.v1.LineItem\"})\n})\n\nThis is currently an experimental API because the structure of the generated content will change to come closer to the Table that you get out of templates.\nThe public method and property will not change but the internal structure will so be careful on your usage.\n", "isViewNode": true, "type": "object", "properties": { "busy": { "type": "boolean", "description": "An expression that allows you to control the 'busy' state of the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "condensedTableLayout": { "type": "boolean", "description": "Determines whether the table adapts to the condensed layout.", "artifactType": "XMLProperty", "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.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "disableColumnFreeze": { "type": "boolean", "description": "Determines whether the number of fixed columns can be configured in the Column Settings dialog.\nThis property doesn't apply for responsive tables\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "disableCopyToClipboard": { "type": "boolean", "description": "Controls if the copy functionality of the table is disabled or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableAutoColumnWidth": { "type": "boolean", "description": "Specifies if the column width is automatically calculated.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableExport": { "type": "boolean", "description": "Controls if the export functionality of the table is enabled or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableFullScreen": { "type": "boolean", "description": "Controls whether the table can be opened in full-screen mode or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enablePaste": { "type": "boolean", "description": "Controls if the paste functionality of the table is enabled or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enablePastingOfComputedProperties": { "type": "boolean", "description": "Determine whether the data copied to the computed columns is sent to the back end.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "enableSelectAll": { "type": "boolean", "description": "Determines whether the Clear All button is enabled by default.\nTo enable the Clear All button by default, you must set this property to false.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "exportFileName": { "type": "string", "description": "Configures the file name of exported table.\nIt's limited to 31 characters. If the name is longer, it is truncated.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "exportRequestSize": { "type": "number", "description": "Maximum allowed number of records to be exported in one request.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "exportSheetName": { "type": "string", "description": "Configures the sheet name of exported table.\nIt's limited to 31 characters. If the name is longer, it is truncated.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "filterBar": { "type": "string", "description": "ID of the FilterBar building block associated with the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "frozenColumnCount": { "type": "number", "description": "Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.\nThis property is not relevant for responsive tables\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "header": { "type": "string", "description": "Specifies the header text that is shown in the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "headerVisible": { "type": "boolean", "description": "Controls if the header text should be shown or not.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "hierarchyQualifier": { "type": "string", "description": "The hierarchy qualifier used in the RecursiveHierarchy annotation.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "ignoredFields": { "type": "string", "description": "Comma-separated value of fields that must be ignored in the OData metadata by the Table building block.\nThe table building block is not going to create built-in columns or offer table personalization for comma-separated value of fields that are provided in the ignoredfields.\nAny column referencing an ignored field is to be removed.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isCopyToPositionAllowed": { "type": "string", "description": "Defines the extension point to control whether a source node can be copied to a specific parent node.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isMoveToPositionAllowed": { "type": "string", "description": "Defines the extension point to control whether a source node can be dropped on a specific parent node.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isNodeCopyable": { "type": "string", "description": "Defines the extension point to control whether a node can be copied.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isNodeMovable": { "type": "string", "description": "Defines the extension point to control if a node can be dragged.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isSearchable": { "type": "boolean", "description": "Defines whether to display the search action.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "metaPath": { "type": "string", "description": "Defines the relative path to a LineItem, PresentationVariant, or SelectionPresentationVariant in the metamodel, based on the current contextPath.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "modeForNoDataMessage": { "type": "string", "description": "Changes the size of the IllustratedMessage in the table, or removes it completely.\nAllowed values are `illustratedMessage-Auto`, `illustratedMessage-Base`, `illustratedMessage-Dialog`, `illustratedMessage-Dot`, `illustratedMessage-Scene`, `illustratedMessage-Spot` or `text`.", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "illustratedMessage-Auto", "illustratedMessage-Base", "illustratedMessage-Medium", "illustratedMessage-Dot", "illustratedMessage-ExtraSmall", "illustratedMessage-Scene", "illustratedMessage-Large", "illustratedMessage-Spot", "illustratedMessage-Small", "text" ] }, "personalization": { "type": "string", "description": "Controls which options should be enabled for the table personalization dialog.\nIf 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- Group\n\nThe Group option is only applicable to analytical tables and responsive tables.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "popinLayout": { "type": "string", "description": "Defines the layout options of the table popins. Only applies to responsive tables.\nAllowed values are `Block`, `GridLarge`, and `GridSmall`.\n- `Block`: Sets a block layout for rendering the table popins. The elements inside the popin container are rendered one below the other.\n- `GridLarge`: Sets a grid layout for rendering the table popins. The grid width for each table popin is comparatively larger than GridSmall, so this layout allows less content to be rendered in a single popin row.\n- `GridSmall`: Sets a grid layout for rendering the table popins. The grid width for each table popin is small, so this layout allows more content to be rendered in a single popin row.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Block", "GridLarge", "GridSmall" ] }, "readOnly": { "type": "boolean", "description": "An expression that allows you to control the 'read-only' state of the table.\nIf you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the current state.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "rowCount": { "type": "number", "description": "Number of rows to be displayed in the table. Does not apply to responsive tables.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "rowCountMode": { "type": "string", "description": "Defines how the table handles the visible rows. Does not apply to responsive tables.\nAllowed values are `Auto`, `Fixed`, and `Interactive`.\n- If set to `Fixed`, the table always has as many rows as defined in the rowCount property.\n- If set to `Auto`, the number of rows is changed by the table automatically. The table adjusts the number of rows based on the available space, which is limited by the surrounding container. The table cannot have fewer rows than defined in the `rowCount` property.\n- If set to `Interactive` the table can have as many rows as defined in the rowCount property. The number of rows can be modified by dragging the resizer.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "Auto", "Fixed", "Interactive" ] }, "scrollThreshold": { "type": "number", "description": "Defines how many additional data records are requested from the back-end system when the user scrolls vertically in the table.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "selectionLimit": { "type": "number", "description": "Defines the maximum number of rows that can be selected at once in the table.\nThis property does not apply to responsive tables.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "selectionMode": { "type": "string", "description": "Defines the selection mode to be used by the table.\nAllowed values are `None`, `Single`, `ForceSingle`, `Multi`, `ForceMulti`, or `Auto`.\nIf set to `Single`, `Multi`, or `Auto`, SAP Fiori elements hooks into the standard lifecycle to determine a consistent selection mode.\nIf set to `ForceSingle` or `ForceMulti`, note this may not adhere to the SAP Fiori guidelines.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "None", "Single", "Multi", "Auto", "ForceMulti", "ForceSingle" ] }, "threshold": { "type": "number", "description": "Defines the number of records to be initially requested from the back end.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "type": { "type": "string", "description": "Defines the type of table that will be used by the building block to render the data. This setting is defined by the framework.\nAllowed value is `TreeTable`.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "const": "TreeTable" }, "variantManagement": { "type": "string", "description": "Controls the kind of variant management that should be enabled for the table.\nAllowed value is `Control`.\nIf set with value `Control`, a variant management control is seen within the table and the table is linked to this.\nIf not set with any value, control level variant management is not available for this table.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "", "Control" ] }, "widthIncludingColumnHeader": { "type": "boolean", "description": "Indicates if the column header should be a part of the width calculation.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "creationMode": { "$ref": "#/definitions/sap.fe.macros.table.TreeTableCreationOptions", "description": "A set of options that can be configured.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "actionOverflowGroups": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.OverflowGroup" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "actions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.Action" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "analyticalConfiguration": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.AnalyticalConfiguration" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "A set of options that can be configured to control the aggregation behavior" }, "columns": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.Column" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } }, "massEdit": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.MassEdit" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "Aggregate mass edit of the table." }, "quickVariantSelection": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.QuickVariantSelection" }, "isViewNode": false, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Single" }, "description": "Aggregate quickVariantSelection of the table." }, "beforeRebindTable": { "type": "string", "description": "Before a table rebind, an event is triggered that contains information about the binding.\nThe event contains a parameter, `collectionBindingInfo`, which is an instance of `CollectionBindingInfoAPI`.\nIt can also contain an optional parameter, `quickFilterKey`, which indicates what is the quick filter key (if any) being processed for the table.\nThis allows you to manipulate the table's list binding.\nYou can use this event to attach event handlers to the table's list binding.\nYou can use this event to add selects, and add or read the sorters and filters.\n", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "rowPress": { "type": "string", "description": "An event is triggered when the user chooses a row. The event contains information about which row is chosen.\nYou can set this to handle the navigation manually.\n", "artifactType": "XMLProperty", "metadata": { "type": "Event" } }, "selectionChange": { "type": "string", "description": "An event triggered when the selection in the table changes.", "artifactType": "XMLProperty", "metadata": { "type": "Event" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.table.TreeTableCreationOptions": { "description": "Create options for the tree table.", "isViewNode": false, "type": "object", "properties": { "createInPlace": { "type": "boolean", "description": "Specifies if the new entry should be placed at the position computed by the backend (e.g. taking sorting into account).\nThe default value is 'false' (that is, the new entry is placed as the first child below its parent).\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "creationFields": { "type": "string", "description": "Defines the list of properties that will be displayed in the creation dialog, when the creation mode is set to 'CreationDialog'.\nThe value is a comma-separated list of property names.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "isCreateEnabled": { "type": "string", "description": "Defines the extension point to control the enablement of the Create button or Create Menu buttons.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "name": { "type": "string", "description": "Defines the creation mode to be used by the tree table.\nAllowed values are `NewPage`, `Inline` or `CreationDialog`.\n\nNewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async' or 'Deferred' is used.\nInline - the creation is done inline.\nCreationDialog - the creation is done in the table, with a dialog allowing to specify some initial property values (the properties are listed in `creationFields`).\n\nIf not set with any value:\nif navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "enum": [ "CreationDialog", "Inline", "NewPage" ] }, "nodeType": { "type": "object", "description": "Defines the nodes to be added on the custom create.\nThis object must have the following properties:\npropertyName: the name of the property on the page entity set used to categorize the node type to be created within the hierarchy\nvalues: an array of key, label and an optional creationFields that define a value of the property defined by the propertyName key, its label, and the specific fields to be shown in the creation dialog.\n", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "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", "artifactType": "XMLProperty", "metadata": { "type": "Property" }, "i18nClassification": "BUT: Text of the action group button" }, "placement": { "type": "string", "description": "Defines where this action group should be placed relative to the defined anchor", "artifactType": "XMLProperty", "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", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "key": { "type": "string", "description": "Unique identifier of the ActionGroup", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "id": { "type": "string", "description": "Unique id of control", "artifactType": "XMLProperty", "metadata": { "type": "Property" } }, "actions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/sap.fe.macros.table.Action" }, "isViewNode": true, "metadata": { "path": [], "type": "Aggregation", "aggregationCardinality": "Multiple" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control", "defaultAggregation": "actions" } }, "sap.fe.macros.CollectionBindingInfo.SerializedCollectionBindingInfo": { "isViewNode": true, "type": "object", "properties": {}, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.controls.section.ISingleSectionContributor.ConsumerData": { "description": "Definition of data consumer by section from single control", "isViewNode": true, "type": "object", "properties": { "title": { "type": "string", "description": "Defines the title to be used by the single control.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } }, "sap.fe.macros.controls.section.ISingleSectionContributor.ProviderData": { "description": "Definition of data provided by section to single control", "isViewNode": true, "type": "object", "properties": { "title": { "type": "string", "description": "Defines the title to be used by the section.", "artifactType": "XMLProperty", "metadata": { "type": "Property" } } }, "additionalProperties": false, "metadata": { "path": [], "type": "Control" } } }, "$schema": "http://json-schema.org/draft-07/schema#" }