From 924ecba4727558394f9c4c8a1c324e867752254c Mon Sep 17 00:00:00 2001 From: D024504 Date: Fri, 13 Sep 2024 18:17:16 +0200 Subject: [PATCH] https://github.com/SAP/odata-vocabularies/pull/344#discussion_r1758916880 --- vocabularies/UI.json | 32 +- vocabularies/UI.md | 785 ++++++++++++++++++++----------------------- vocabularies/UI.xml | 29 +- 3 files changed, 402 insertions(+), 444 deletions(-) diff --git a/vocabularies/UI.json b/vocabularies/UI.json index 577ffbcd..1f442f9a 100644 --- a/vocabularies/UI.json +++ b/vocabularies/UI.json @@ -614,33 +614,31 @@ "Description": { "$Nullable": true, "@Core.Description": "Short description", "@Core.IsLanguageDependent": true }, "Columns": { "$Collection": true, - "$Type": "UI.DataFieldGridAbstract", - "@Core.Description": "Columns of the grid" + "$Type": "UI.ReferenceFacet", + "@Core.Description": "Columns of the grid", + "@Core.LongDescription": "Each facet must reference one of\n- [`FieldGroupDimensions`](#FieldGroupDimensions)\n- [`FieldGroupMeasures`](#FieldGroupMeasures) \n Exactly one such facet must occur in `Columns` and `Rows` together.\n- a [`CollectionFacet`](#CollectionFacet) of `ReferenceFacet`s whose `Target`s are [`Analytics.StructureElement`](Analytics.md#StructureElement)s \n At most one such facet may occur in `Columns` and `Rows` together." + }, + "Rows": { + "$Collection": true, + "$Type": "UI.ReferenceFacet", + "@Core.Description": "Rows of the grid", + "@Core.LongDescription": "The same conditions as for `Columns` apply to the facets." }, - "Rows": { "$Collection": true, "$Type": "UI.DataFieldGridAbstract" }, "Actions": { "$Collection": true, "$Type": "UI.DataFieldForActionAbstract", "@Core.Description": "Available actions" } }, - "DataFieldGridAbstract": { - "$Kind": "ComplexType", - "$Abstract": true, - "$BaseType": "UI.DataFieldAbstract", - "@Core.Description": "Abstract type to restrict usage in Grid" - }, - "DataFieldMeasures": { + "FieldGroupDimensions": { "$Kind": "ComplexType", - "$BaseType": "UI.DataFieldGridAbstract", - "@Core.Description": "A structured piece of data described by an annotation", - "Measures": { "$Collection": true, "$Type": "Edm.PropertyPath" } + "$BaseType": "UI.FieldGroupType", + "@Core.Description": "Field group whose `Data` consists of [`DataField`](#DataField)s whose `Value` occurs in [`Analytics.AnalyticalContext/Dimensions`](Analytics.md#AnalyticalContextType)" }, - "DataFieldDimension": { + "FieldGroupMeasures": { "$Kind": "ComplexType", - "$BaseType": "UI.DataFieldGridAbstract", - "@Core.Description": "A structured piece of data described by an annotation", - "Dimensions": { "$Type": "Edm.PropertyPath" } + "$BaseType": "UI.FieldGroupType", + "@Core.Description": "Field group whose `Data` consists of [`DataField`](#DataField)s whose `Value` occurs in [`Analytics.AnalyticalContext/Measures`](Analytics.md#AnalyticalContextType)" }, "Chart": { "$Kind": "Term", diff --git a/vocabularies/UI.md b/vocabularies/UI.md index 322293df..fea40eb5 100644 --- a/vocabularies/UI.md +++ b/vocabularies/UI.md @@ -34,52 +34,52 @@ Term|Type|Description [DataPoint](UI.xml#L351)|[DataPointType](#DataPointType)|Visualization of a single point of data, typically a number; may also be textual, e.g. a status value [KPI](UI.xml#L659)|[KPIType](#KPIType)|A Key Performance Indicator (KPI) bundles a SelectionVariant and a DataPoint, and provides details for progressive disclosure [DataGrid](UI.xml#L705)|[DataGridType](#DataGridType)|Visualization of a data grid -[Chart](UI.xml#L739)|[ChartDefinitionType](#ChartDefinitionType)|Visualization of multiple data points -[ValueCriticality](UI.xml#L963) *([Experimental](Common.md#Experimental))*|\[[ValueCriticalityType](#ValueCriticalityType)\]|Assign criticalities to primitive values. This information can be used for semantic coloring. -[CriticalityLabels](UI.xml#L976) *([Experimental](Common.md#Experimental))*|\[[CriticalityLabelType](#CriticalityLabelType)\]|Assign labels to criticalities. This information can be used for semantic coloring. When applied to a property, a label for a criticality must be provided, if more than one value of the annotated property has been assigned to the same criticality. There must be no more than one label per criticality. -[SelectionFields](UI.xml#L997)|\[PropertyPath\]|Properties that might be relevant for filtering a collection of entities of this type -[Facets](UI.xml#L1004)|\[[Facet](#Facet)\]|Collection of facets -[HeaderFacets](UI.xml#L1008)|\[[Facet](#Facet)\]|Facets for additional object header information -[QuickViewFacets](UI.xml#L1012)|\[[Facet](#Facet)\]|Facets that may be used for a quick overview of the object -[QuickCreateFacets](UI.xml#L1016)|\[[Facet](#Facet)\]|Facets that may be used for a (quick) create of the object -[FilterFacets](UI.xml#L1020)|\[[ReferenceFacet](#ReferenceFacet)\]|Facets that reference UI.FieldGroup annotations to group filterable fields -[SelectionPresentationVariant](UI.xml#L1093)|[SelectionPresentationVariantType](#SelectionPresentationVariantType)|A SelectionPresentationVariant bundles a Selection Variant and a Presentation Variant -[PresentationVariant](UI.xml#L1117)|[PresentationVariantType](#PresentationVariantType)|Defines how the result of a queried collection of entities is shaped and how this result is displayed -[SelectionVariant](UI.xml#L1234)|[SelectionVariantType](#SelectionVariantType)|A SelectionVariant denotes a combination of parameters and filters to query the annotated entity set -[ThingPerspective](UI.xml#L1390)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|The annotated term is a Thing Perspective -[IsSummary](UI.xml#L1393)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|This Facet and all included Facets are the summary of the thing. At most one Facet of a thing can be tagged with this term -[PartOfPreview](UI.xml#L1397)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|This record and all included structural elements are part of the Thing preview
This term can be applied e.g. to UI.Facet and UI.DataField -[Map](UI.xml#L1401)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Target MUST reference a UI.GeoLocation, Communication.Address or a collection of these -[Gallery](UI.xml#L1405)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Target MUST reference a UI.MediaResource -[IsImageURL](UI.xml#L1410)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Properties and terms annotated with this term MUST contain a valid URL referencing an resource with a MIME type image
Can be annotated with: -[IsImage](UI.xml#L1420) *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Properties annotated with this term MUST be a stream property annotated with a MIME type image. Entity types annotated with this term MUST be a media entity type annotated with a MIME type image.
Can be annotated with: -[MultiLineText](UI.xml#L1431)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Properties and parameters annotated with this annotation should be rendered as multi-line text (e.g. text area) -[Placeholder](UI.xml#L1436)|String|A short, human-readable text that gives a hint or an example to help the user with data entry -[InputMask](UI.xml#L1441) *([Experimental](Common.md#Experimental))*|[InputMaskType](#InputMaskType)|Properties or parameters annotated with this term will get a mask in edit mode
Input masks improve readability and help to enter data correctly. So, masks can be especially useful for input fields that have a fixed pattern, e.g. DUNS numbers or similar. [Here](../examples/UI.InputMask-sample.xml) you can find an example for this annotation -[TextArrangement](UI.xml#L1475)|[TextArrangementType](#TextArrangementType)|Describes the arrangement of a code or ID value and its text

This term annotates one of the following:

  1. a Common.Text annotation of the code or ID property where the annotation value is the text
  2. an entity type, this has the same effect as annotating all Common.Text annotations of properties of that entity type.
-[DateTimeStyle](UI.xml#L1498) *([Experimental](Common.md#Experimental))*|String?|The temporal value represented by the annotated property or parameter shall be shown on the UI in the given style
Requires type `Edm.Date`, `Edm.TimeOfDay`, or `Edm.DateTimeOffset`. If this annotation is absent or null or an empty string, temporal values are shown in a default style.
Allowed values:
[short](UI.xml#L1507)
7/25/24, 1:11 PM
[medium](UI.xml#L1511)
Jul 25, 2024, 1:11:51 PM
[long](UI.xml#L1515)
July 25, 2024 at 1:11:51 PM GMT+2
[full](UI.xml#L1519)
Thursday, July 25, 2024 at 1:11:51 PM Central European Summer Time
-[Note](UI.xml#L1527) *([Experimental](Common.md#Experimental))*|[NoteType](#NoteType)|Visualization of a note attached to an entity
Administrative data is given by the annotations [`Common.CreatedBy`](Common.md#CreatedBy), [`Common.CreatedAt`](Common.md#CreatedAt), [`Common.ChangedBy`](Common.md#ChangedBy), [`Common.ChangedAt`](Common.md#ChangedAt) on the same entity type. -[Importance](UI.xml#L1580)|[ImportanceType](#ImportanceType)|Expresses the importance of e.g. a DataField or an annotation -[Hidden](UI.xml#L1595)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Properties or facets (see UI.Facet) annotated with this term will not be rendered if the annotation evaluates to true.
Hidden properties usually carry technical information that is used for application control and is of no direct interest to end users. The annotation value may be an expression to dynamically hide or render the annotated feature. If a navigation property is annotated with `Hidden` true, all subsequent parts are hidden - independent of their own potential `Hidden` annotations. -[IsCopyAction](UI.xml#L1603) *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|The annotated [`DataFieldForAction`](#DataFieldForAction) record references an action that deep-copies an instance of the annotated entity type
The referenced action MUST be bound to the annotated entity type and MUST create a new instance of the same entity type as a deep copy of the bound instance. Upon successful completion, the response MUST contain a `Location` header that contains the edit URL or read URL of the created entity, and the response MUST be either `201 Created` and a representation of the created entity, or `204 No Content` if the request included a `Prefer` header with a value of `return=minimal` and did not include the system query options `$select` and `$expand`. -[IsAIOperation](UI.xml#L1615) *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|The annotated operation is powered by AI
This term allows making end-users aware that the annotated operation uses AI functionality to process the selected application data. -[CreateHidden](UI.xml#L1623)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|EntitySets annotated with this term can control the visibility of the Create operation dynamically
The annotation value should be a path to another property from a related entity. -[UpdateHidden](UI.xml#L1628)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|EntitySets annotated with this term can control the visibility of the Edit/Save operation dynamically
The annotation value should be a path to another property from the same or a related entity. -[DeleteHidden](UI.xml#L1633)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|EntitySets annotated with this term can control the visibility of the Delete operation dynamically
The annotation value should be a path to another property from the same or a related entity. -[HiddenFilter](UI.xml#L1638)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Properties annotated with this term will not be rendered as filter criteria if the annotation evaluates to true.
Properties annotated with `HiddenFilter` are intended as parts of a `$filter` expression that cannot be directly influenced by end users. The properties will be rendered in all other places, e.g. table columns or form fields. This is in contrast to properties annotated with [Hidden](#Hidden) that are not rendered at all. If a navigation property is annotated with `HiddenFilter` true, all subsequent parts are hidden in filter - independent of their own potential `HiddenFilter` annotations. -[AdaptationHidden](UI.xml#L1647) *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Properties or entities annotated with this term can't be used for UI adaptation/configuration/personalization
The tagged elements can only be used in UI based on metadata, annnotations or code. -[DataFieldDefault](UI.xml#L1653)|[DataFieldAbstract](#DataFieldAbstract)|Default representation of a property as a datafield, e.g. when the property is added as a table column or form field via personalization
Only concrete subtypes of [DataFieldAbstract](#DataFieldAbstract) can be used for a DataFieldDefault. For type [DataField](#DataField) and its subtypes the annotation target SHOULD be the same property that is referenced via a path expression in the `Value` of the datafield. -[Criticality](UI.xml#L1878)|[CriticalityType](#CriticalityType)|Service-calculated criticality, alternative to UI.CriticalityCalculation -[CriticalityCalculation](UI.xml#L1882)|[CriticalityCalculationType](#CriticalityCalculationType)|Parameters for client-calculated criticality, alternative to UI.Criticality -[Emphasized](UI.xml#L1886) *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Highlight something that is of special interest
The usage of a property or operation should be highlighted as it's of special interest for the end user -[OrderBy](UI.xml#L1892) *([Experimental](Common.md#Experimental))*|PropertyPath|Sort by the referenced property instead of by the annotated property
Example: annotated property `SizeCode` has string values XS, S, M, L, XL, referenced property SizeOrder has numeric values -2, -1, 0, 1, 2. Numeric ordering by SizeOrder will be more understandable than lexicographic ordering by SizeCode. -[ParameterDefaultValue](UI.xml#L1898)|PrimitiveType?|Define default values for action parameters
For unbound actions the default value can either be a constant expression, or a dynamic expression using absolute paths, e.g. singletons or function import results. Whereas for bound actions the bound entity and its properties and associated properties can be used as default values -[RecommendationState](UI.xml#L1904)|[RecommendationStateType](#RecommendationStateType)|Indicates whether a field contains or has a recommended value
Intelligent systems can help users by recommending input the user may "prefer". -[RecommendationList](UI.xml#L1934)|[RecommendationListType](#RecommendationListType)|Specifies how to get a list of recommended values for a property or parameter
Intelligent systems can help users by recommending input the user may "prefer". -[Recommendations](UI.xml#L1966) *([Experimental](Common.md#Experimental))*|ComplexType|Recommendations for an entity
This complex-typed annotation contains structural properties corresponding via name equality to non-key structural primitive properties of the entity type for which recommendations are available. The type of such a property is a collection of a informal specialization of [`PropertyRecommendationType`](#PropertyRecommendationType). (The specializiations are called "informal" because they may omit the property `RecommendedFieldDescription`.)
Clients retrieve the recommendations with a GET request that includes this annotation in a `$select` clause. The recommendations MAY be computed asynchronously, see [this diagram](../docs/recommendations.md). -[ExcludeFromNavigationContext](UI.xml#L2012)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|The contents of this property must not be propagated to the app-to-app navigation context -[DoNotCheckScaleOfMeasuredQuantity](UI.xml#L2016) *([Experimental](Common.md#Experimental))*|Boolean|Do not check the number of fractional digits of the annotated measured quantity
The annotated property contains a measured quantity, and the user may enter more fractional digits than defined for the corresponding unit of measure.
This switches off the validation of user input with respect to decimals. -[LeadingEntitySet](UI.xml#L2026) *([Experimental](Common.md#Experimental))*|String|The referenced entity set is the preferred starting point for UIs using this service +[Chart](UI.xml#L746)|[ChartDefinitionType](#ChartDefinitionType)|Visualization of multiple data points +[ValueCriticality](UI.xml#L970) *([Experimental](Common.md#Experimental))*|\[[ValueCriticalityType](#ValueCriticalityType)\]|Assign criticalities to primitive values. This information can be used for semantic coloring. +[CriticalityLabels](UI.xml#L983) *([Experimental](Common.md#Experimental))*|\[[CriticalityLabelType](#CriticalityLabelType)\]|Assign labels to criticalities. This information can be used for semantic coloring. When applied to a property, a label for a criticality must be provided, if more than one value of the annotated property has been assigned to the same criticality. There must be no more than one label per criticality. +[SelectionFields](UI.xml#L1004)|\[PropertyPath\]|Properties that might be relevant for filtering a collection of entities of this type +[Facets](UI.xml#L1011)|\[[Facet](#Facet)\]|Collection of facets +[HeaderFacets](UI.xml#L1015)|\[[Facet](#Facet)\]|Facets for additional object header information +[QuickViewFacets](UI.xml#L1019)|\[[Facet](#Facet)\]|Facets that may be used for a quick overview of the object +[QuickCreateFacets](UI.xml#L1023)|\[[Facet](#Facet)\]|Facets that may be used for a (quick) create of the object +[FilterFacets](UI.xml#L1027)|\[[ReferenceFacet](#ReferenceFacet)\]|Facets that reference UI.FieldGroup annotations to group filterable fields +[SelectionPresentationVariant](UI.xml#L1100)|[SelectionPresentationVariantType](#SelectionPresentationVariantType)|A SelectionPresentationVariant bundles a Selection Variant and a Presentation Variant +[PresentationVariant](UI.xml#L1124)|[PresentationVariantType](#PresentationVariantType)|Defines how the result of a queried collection of entities is shaped and how this result is displayed +[SelectionVariant](UI.xml#L1241)|[SelectionVariantType](#SelectionVariantType)|A SelectionVariant denotes a combination of parameters and filters to query the annotated entity set +[ThingPerspective](UI.xml#L1397)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|The annotated term is a Thing Perspective +[IsSummary](UI.xml#L1400)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|This Facet and all included Facets are the summary of the thing. At most one Facet of a thing can be tagged with this term +[PartOfPreview](UI.xml#L1404)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|This record and all included structural elements are part of the Thing preview
This term can be applied e.g. to UI.Facet and UI.DataField +[Map](UI.xml#L1408)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Target MUST reference a UI.GeoLocation, Communication.Address or a collection of these +[Gallery](UI.xml#L1412)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Target MUST reference a UI.MediaResource +[IsImageURL](UI.xml#L1417)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Properties and terms annotated with this term MUST contain a valid URL referencing an resource with a MIME type image
Can be annotated with: +[IsImage](UI.xml#L1427) *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Properties annotated with this term MUST be a stream property annotated with a MIME type image. Entity types annotated with this term MUST be a media entity type annotated with a MIME type image.
Can be annotated with: +[MultiLineText](UI.xml#L1438)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Properties and parameters annotated with this annotation should be rendered as multi-line text (e.g. text area) +[Placeholder](UI.xml#L1443)|String|A short, human-readable text that gives a hint or an example to help the user with data entry +[InputMask](UI.xml#L1448) *([Experimental](Common.md#Experimental))*|[InputMaskType](#InputMaskType)|Properties or parameters annotated with this term will get a mask in edit mode
Input masks improve readability and help to enter data correctly. So, masks can be especially useful for input fields that have a fixed pattern, e.g. DUNS numbers or similar. [Here](../examples/UI.InputMask-sample.xml) you can find an example for this annotation +[TextArrangement](UI.xml#L1482)|[TextArrangementType](#TextArrangementType)|Describes the arrangement of a code or ID value and its text

This term annotates one of the following:

  1. a Common.Text annotation of the code or ID property where the annotation value is the text
  2. an entity type, this has the same effect as annotating all Common.Text annotations of properties of that entity type.
+[DateTimeStyle](UI.xml#L1505) *([Experimental](Common.md#Experimental))*|String?|The temporal value represented by the annotated property or parameter shall be shown on the UI in the given style
Requires type `Edm.Date`, `Edm.TimeOfDay`, or `Edm.DateTimeOffset`. If this annotation is absent or null or an empty string, temporal values are shown in a default style.
Allowed values:
[short](UI.xml#L1514)
7/25/24, 1:11 PM
[medium](UI.xml#L1518)
Jul 25, 2024, 1:11:51 PM
[long](UI.xml#L1522)
July 25, 2024 at 1:11:51 PM GMT+2
[full](UI.xml#L1526)
Thursday, July 25, 2024 at 1:11:51 PM Central European Summer Time
+[Note](UI.xml#L1534) *([Experimental](Common.md#Experimental))*|[NoteType](#NoteType)|Visualization of a note attached to an entity
Administrative data is given by the annotations [`Common.CreatedBy`](Common.md#CreatedBy), [`Common.CreatedAt`](Common.md#CreatedAt), [`Common.ChangedBy`](Common.md#ChangedBy), [`Common.ChangedAt`](Common.md#ChangedAt) on the same entity type. +[Importance](UI.xml#L1587)|[ImportanceType](#ImportanceType)|Expresses the importance of e.g. a DataField or an annotation +[Hidden](UI.xml#L1602)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Properties or facets (see UI.Facet) annotated with this term will not be rendered if the annotation evaluates to true.
Hidden properties usually carry technical information that is used for application control and is of no direct interest to end users. The annotation value may be an expression to dynamically hide or render the annotated feature. If a navigation property is annotated with `Hidden` true, all subsequent parts are hidden - independent of their own potential `Hidden` annotations. +[IsCopyAction](UI.xml#L1610) *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|The annotated [`DataFieldForAction`](#DataFieldForAction) record references an action that deep-copies an instance of the annotated entity type
The referenced action MUST be bound to the annotated entity type and MUST create a new instance of the same entity type as a deep copy of the bound instance. Upon successful completion, the response MUST contain a `Location` header that contains the edit URL or read URL of the created entity, and the response MUST be either `201 Created` and a representation of the created entity, or `204 No Content` if the request included a `Prefer` header with a value of `return=minimal` and did not include the system query options `$select` and `$expand`. +[IsAIOperation](UI.xml#L1622) *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|The annotated operation is powered by AI
This term allows making end-users aware that the annotated operation uses AI functionality to process the selected application data. +[CreateHidden](UI.xml#L1630)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|EntitySets annotated with this term can control the visibility of the Create operation dynamically
The annotation value should be a path to another property from a related entity. +[UpdateHidden](UI.xml#L1635)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|EntitySets annotated with this term can control the visibility of the Edit/Save operation dynamically
The annotation value should be a path to another property from the same or a related entity. +[DeleteHidden](UI.xml#L1640)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|EntitySets annotated with this term can control the visibility of the Delete operation dynamically
The annotation value should be a path to another property from the same or a related entity. +[HiddenFilter](UI.xml#L1645)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Properties annotated with this term will not be rendered as filter criteria if the annotation evaluates to true.
Properties annotated with `HiddenFilter` are intended as parts of a `$filter` expression that cannot be directly influenced by end users. The properties will be rendered in all other places, e.g. table columns or form fields. This is in contrast to properties annotated with [Hidden](#Hidden) that are not rendered at all. If a navigation property is annotated with `HiddenFilter` true, all subsequent parts are hidden in filter - independent of their own potential `HiddenFilter` annotations. +[AdaptationHidden](UI.xml#L1654) *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Properties or entities annotated with this term can't be used for UI adaptation/configuration/personalization
The tagged elements can only be used in UI based on metadata, annnotations or code. +[DataFieldDefault](UI.xml#L1660)|[DataFieldAbstract](#DataFieldAbstract)|Default representation of a property as a datafield, e.g. when the property is added as a table column or form field via personalization
Only concrete subtypes of [DataFieldAbstract](#DataFieldAbstract) can be used for a DataFieldDefault. For type [DataField](#DataField) and its subtypes the annotation target SHOULD be the same property that is referenced via a path expression in the `Value` of the datafield. +[Criticality](UI.xml#L1885)|[CriticalityType](#CriticalityType)|Service-calculated criticality, alternative to UI.CriticalityCalculation +[CriticalityCalculation](UI.xml#L1889)|[CriticalityCalculationType](#CriticalityCalculationType)|Parameters for client-calculated criticality, alternative to UI.Criticality +[Emphasized](UI.xml#L1893) *([Experimental](Common.md#Experimental))*|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|Highlight something that is of special interest
The usage of a property or operation should be highlighted as it's of special interest for the end user +[OrderBy](UI.xml#L1899) *([Experimental](Common.md#Experimental))*|PropertyPath|Sort by the referenced property instead of by the annotated property
Example: annotated property `SizeCode` has string values XS, S, M, L, XL, referenced property SizeOrder has numeric values -2, -1, 0, 1, 2. Numeric ordering by SizeOrder will be more understandable than lexicographic ordering by SizeCode. +[ParameterDefaultValue](UI.xml#L1905)|PrimitiveType?|Define default values for action parameters
For unbound actions the default value can either be a constant expression, or a dynamic expression using absolute paths, e.g. singletons or function import results. Whereas for bound actions the bound entity and its properties and associated properties can be used as default values +[RecommendationState](UI.xml#L1911)|[RecommendationStateType](#RecommendationStateType)|Indicates whether a field contains or has a recommended value
Intelligent systems can help users by recommending input the user may "prefer". +[RecommendationList](UI.xml#L1941)|[RecommendationListType](#RecommendationListType)|Specifies how to get a list of recommended values for a property or parameter
Intelligent systems can help users by recommending input the user may "prefer". +[Recommendations](UI.xml#L1973) *([Experimental](Common.md#Experimental))*|ComplexType|Recommendations for an entity
This complex-typed annotation contains structural properties corresponding via name equality to non-key structural primitive properties of the entity type for which recommendations are available. The type of such a property is a collection of a informal specialization of [`PropertyRecommendationType`](#PropertyRecommendationType). (The specializiations are called "informal" because they may omit the property `RecommendedFieldDescription`.)
Clients retrieve the recommendations with a GET request that includes this annotation in a `$select` clause. The recommendations MAY be computed asynchronously, see [this diagram](../docs/recommendations.md). +[ExcludeFromNavigationContext](UI.xml#L2019)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|The contents of this property must not be propagated to the app-to-app navigation context +[DoNotCheckScaleOfMeasuredQuantity](UI.xml#L2023) *([Experimental](Common.md#Experimental))*|Boolean|Do not check the number of fractional digits of the annotated measured quantity
The annotated property contains a measured quantity, and the user may enter more fractional digits than defined for the corresponding unit of measure.
This switches off the validation of user input with respect to decimals. +[LeadingEntitySet](UI.xml#L2033) *([Experimental](Common.md#Experimental))*|String|The referenced entity set is the preferred starting point for UIs using this service ## [HeaderInfoType](UI.xml#L68) @@ -113,6 +113,10 @@ Property|Type|Description ## [FieldGroupType](UI.xml#L161) +**Derived Types:** +- [FieldGroupDimensions](#FieldGroupDimensions) +- [FieldGroupMeasures](#FieldGroupMeasures) + Property|Type|Description :-------|:---|:---------- [Label](UI.xml#L162)|String?|Label for the field group @@ -397,259 +401,211 @@ Property|Type|Description :-------|:---|:---------- [Title](UI.xml#L710)|String?|Title of the grid [Description](UI.xml#L714)|String?|Short description -[Columns](UI.xml#L718)|\[[DataFieldGridAbstract](#DataFieldGridAbstract)\]|Columns of the grid -[Rows](UI.xml#L721)|\[[DataFieldGridAbstract](#DataFieldGridAbstract)\]| -[Actions](UI.xml#L723)|\[[DataFieldForActionAbstract](#DataFieldForActionAbstract)\]|Available actions +[Columns](UI.xml#L718)|\[[ReferenceFacet](#ReferenceFacet)\]|Columns of the grid

Each facet must reference one of

+[Rows](UI.xml#L729)|\[[ReferenceFacet](#ReferenceFacet)\]|Rows of the grid
The same conditions as for `Columns` apply to the facets. +[Actions](UI.xml#L735)|\[[DataFieldForActionAbstract](#DataFieldForActionAbstract)\]|Available actions - -## [*DataFieldGridAbstract*](UI.xml#L727): [DataFieldAbstract](#DataFieldAbstract) -Abstract type to restrict usage in Grid - -**Derived Types:** -- [DataFieldMeasures](#DataFieldMeasures) -- [DataFieldDimension](#DataFieldDimension) + +## [FieldGroupDimensions](UI.xml#L739): [FieldGroupType](#FieldGroupType) +Field group whose `Data` consists of [`DataField`](#DataField)s whose `Value` occurs in [`Analytics.AnalyticalContext/Dimensions`](Analytics.md#AnalyticalContextType) Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon +[*Label*](UI.xml#L162)|String?|Label for the field group +[*Data*](UI.xml#L166)|\[[DataFieldAbstract](#DataFieldAbstract)\]|Collection of data fields -**Applicable Annotation Terms:** - -- [Hidden](#Hidden) -- [Importance](#Importance) -- [PartOfPreview](#PartOfPreview) -- [CssDefaults](HTML5.md#CssDefaults) -- [RowSpanForDuplicateValues](HTML5.md#RowSpanForDuplicateValues) -- [FieldControl](Common.md#FieldControl) - - -## [DataFieldMeasures](UI.xml#L730): [DataFieldGridAbstract](#DataFieldGridAbstract) -A structured piece of data described by an annotation + +## [FieldGroupMeasures](UI.xml#L742): [FieldGroupType](#FieldGroupType) +Field group whose `Data` consists of [`DataField`](#DataField)s whose `Value` occurs in [`Analytics.AnalyticalContext/Measures`](Analytics.md#AnalyticalContextType) Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon -[Measures](UI.xml#L732)|\[PropertyPath\]| - -**Applicable Annotation Terms:** - -- [Hidden](#Hidden) -- [Importance](#Importance) -- [PartOfPreview](#PartOfPreview) -- [CssDefaults](HTML5.md#CssDefaults) -- [RowSpanForDuplicateValues](HTML5.md#RowSpanForDuplicateValues) -- [FieldControl](Common.md#FieldControl) - - -## [DataFieldDimension](UI.xml#L734): [DataFieldGridAbstract](#DataFieldGridAbstract) -A structured piece of data described by an annotation - -Property|Type|Description -:-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon -[Dimensions](UI.xml#L736)|PropertyPath| - -**Applicable Annotation Terms:** - -- [Hidden](#Hidden) -- [Importance](#Importance) -- [PartOfPreview](#PartOfPreview) -- [CssDefaults](HTML5.md#CssDefaults) -- [RowSpanForDuplicateValues](HTML5.md#RowSpanForDuplicateValues) -- [FieldControl](Common.md#FieldControl) +[*Label*](UI.xml#L162)|String?|Label for the field group +[*Data*](UI.xml#L166)|\[[DataFieldAbstract](#DataFieldAbstract)\]|Collection of data fields -## [ChartDefinitionType](UI.xml#L743) +## [ChartDefinitionType](UI.xml#L750) Property|Type|Description :-------|:---|:---------- -[Title](UI.xml#L744)|String?|Title of the chart -[Description](UI.xml#L748)|String?|Short description -[ChartType](UI.xml#L752)|[ChartType](#ChartType)|Chart type -[AxisScaling](UI.xml#L755)|[ChartAxisScalingType?](#ChartAxisScalingType)|Describes the scale of the chart value axes -[Measures](UI.xml#L758)|\[PropertyPath\]|Measures of the chart, e.g. size and color in a bubble chart -[DynamicMeasures](UI.xml#L762)|\[AnnotationPath\]|Dynamic properties introduced by annotations and used as measures of the chart
If the annotation referenced by an annotation path does not apply to the same collection of entities as the one being visualized according to the `UI.Chart` annotation, the annotation path MUST be silently ignored.
Allowed terms: -[MeasureAttributes](UI.xml#L775)|\[[ChartMeasureAttributeType](#ChartMeasureAttributeType)\]|Describes Attributes for Measures. All Measures used in this collection must also be part of the Measures Property. -[Dimensions](UI.xml#L780)|\[PropertyPath\]|Dimensions of the chart, e.g. x- and y-axis of a bubble chart -[DimensionAttributes](UI.xml#L783)|\[[ChartDimensionAttributeType](#ChartDimensionAttributeType)\]|Describes Attributes for Dimensions. All Dimensions used in this collection must also be part of the Dimensions Property. -[Actions](UI.xml#L788)|\[[DataFieldForActionAbstract](#DataFieldForActionAbstract)\]|Available actions +[Title](UI.xml#L751)|String?|Title of the chart +[Description](UI.xml#L755)|String?|Short description +[ChartType](UI.xml#L759)|[ChartType](#ChartType)|Chart type +[AxisScaling](UI.xml#L762)|[ChartAxisScalingType?](#ChartAxisScalingType)|Describes the scale of the chart value axes +[Measures](UI.xml#L765)|\[PropertyPath\]|Measures of the chart, e.g. size and color in a bubble chart +[DynamicMeasures](UI.xml#L769)|\[AnnotationPath\]|Dynamic properties introduced by annotations and used as measures of the chart
If the annotation referenced by an annotation path does not apply to the same collection of entities as the one being visualized according to the `UI.Chart` annotation, the annotation path MUST be silently ignored.
Allowed terms: +[MeasureAttributes](UI.xml#L782)|\[[ChartMeasureAttributeType](#ChartMeasureAttributeType)\]|Describes Attributes for Measures. All Measures used in this collection must also be part of the Measures Property. +[Dimensions](UI.xml#L787)|\[PropertyPath\]|Dimensions of the chart, e.g. x- and y-axis of a bubble chart +[DimensionAttributes](UI.xml#L790)|\[[ChartDimensionAttributeType](#ChartDimensionAttributeType)\]|Describes Attributes for Dimensions. All Dimensions used in this collection must also be part of the Dimensions Property. +[Actions](UI.xml#L795)|\[[DataFieldForActionAbstract](#DataFieldForActionAbstract)\]|Available actions -## [ChartType](UI.xml#L793) +## [ChartType](UI.xml#L800) Member|Value|Description :-----|----:|:---------- -[Column](UI.xml#L794)|0| -[ColumnStacked](UI.xml#L795)|1| -[ColumnDual](UI.xml#L796)|2| -[ColumnStackedDual](UI.xml#L797)|3| -[ColumnStacked100](UI.xml#L798)|4| -[ColumnStackedDual100](UI.xml#L799)|5| -[Bar](UI.xml#L800)|6| -[BarStacked](UI.xml#L801)|7| -[BarDual](UI.xml#L802)|8| -[BarStackedDual](UI.xml#L803)|9| -[BarStacked100](UI.xml#L804)|10| -[BarStackedDual100](UI.xml#L805)|11| -[Area](UI.xml#L806)|12| -[AreaStacked](UI.xml#L807)|13| -[AreaStacked100](UI.xml#L808)|14| -[HorizontalArea](UI.xml#L809)|15| -[HorizontalAreaStacked](UI.xml#L810)|16| -[HorizontalAreaStacked100](UI.xml#L811)|17| -[Line](UI.xml#L812)|18| -[LineDual](UI.xml#L813)|19| -[Combination](UI.xml#L814)|20| -[CombinationStacked](UI.xml#L815)|21| -[CombinationDual](UI.xml#L816)|22| -[CombinationStackedDual](UI.xml#L817)|23| -[HorizontalCombinationStacked](UI.xml#L818)|24| -[Pie](UI.xml#L819)|25| -[Donut](UI.xml#L820)|26| -[Scatter](UI.xml#L821)|27| -[Bubble](UI.xml#L822)|28| -[Radar](UI.xml#L823)|29| -[HeatMap](UI.xml#L824)|30| -[TreeMap](UI.xml#L825)|31| -[Waterfall](UI.xml#L826)|32| -[Bullet](UI.xml#L827)|33| -[VerticalBullet](UI.xml#L828)|34| -[HorizontalWaterfall](UI.xml#L829)|35| -[HorizontalCombinationDual](UI.xml#L830)|36| -[HorizontalCombinationStackedDual](UI.xml#L831)|37| -[Donut100](UI.xml#L832) *([Experimental](Common.md#Experimental))*|38| +[Column](UI.xml#L801)|0| +[ColumnStacked](UI.xml#L802)|1| +[ColumnDual](UI.xml#L803)|2| +[ColumnStackedDual](UI.xml#L804)|3| +[ColumnStacked100](UI.xml#L805)|4| +[ColumnStackedDual100](UI.xml#L806)|5| +[Bar](UI.xml#L807)|6| +[BarStacked](UI.xml#L808)|7| +[BarDual](UI.xml#L809)|8| +[BarStackedDual](UI.xml#L810)|9| +[BarStacked100](UI.xml#L811)|10| +[BarStackedDual100](UI.xml#L812)|11| +[Area](UI.xml#L813)|12| +[AreaStacked](UI.xml#L814)|13| +[AreaStacked100](UI.xml#L815)|14| +[HorizontalArea](UI.xml#L816)|15| +[HorizontalAreaStacked](UI.xml#L817)|16| +[HorizontalAreaStacked100](UI.xml#L818)|17| +[Line](UI.xml#L819)|18| +[LineDual](UI.xml#L820)|19| +[Combination](UI.xml#L821)|20| +[CombinationStacked](UI.xml#L822)|21| +[CombinationDual](UI.xml#L823)|22| +[CombinationStackedDual](UI.xml#L824)|23| +[HorizontalCombinationStacked](UI.xml#L825)|24| +[Pie](UI.xml#L826)|25| +[Donut](UI.xml#L827)|26| +[Scatter](UI.xml#L828)|27| +[Bubble](UI.xml#L829)|28| +[Radar](UI.xml#L830)|29| +[HeatMap](UI.xml#L831)|30| +[TreeMap](UI.xml#L832)|31| +[Waterfall](UI.xml#L833)|32| +[Bullet](UI.xml#L834)|33| +[VerticalBullet](UI.xml#L835)|34| +[HorizontalWaterfall](UI.xml#L836)|35| +[HorizontalCombinationDual](UI.xml#L837)|36| +[HorizontalCombinationStackedDual](UI.xml#L838)|37| +[Donut100](UI.xml#L839) *([Experimental](Common.md#Experimental))*|38| -## [ChartAxisScalingType](UI.xml#L838) +## [ChartAxisScalingType](UI.xml#L845) Property|Type|Description :-------|:---|:---------- -[ScaleBehavior](UI.xml#L839)|[ChartAxisScaleBehaviorType](#ChartAxisScaleBehaviorType)|Scale is fixed or adapts automatically to rendered values -[AutoScaleBehavior](UI.xml#L842)|[ChartAxisAutoScaleBehaviorType?](#ChartAxisAutoScaleBehaviorType)|Settings for automatic scaling -[FixedScaleMultipleStackedMeasuresBoundaryValues](UI.xml#L845)|[FixedScaleMultipleStackedMeasuresBoundaryValuesType?](#FixedScaleMultipleStackedMeasuresBoundaryValuesType)|Boundary values for fixed scaling of a stacking chart type with multiple measures +[ScaleBehavior](UI.xml#L846)|[ChartAxisScaleBehaviorType](#ChartAxisScaleBehaviorType)|Scale is fixed or adapts automatically to rendered values +[AutoScaleBehavior](UI.xml#L849)|[ChartAxisAutoScaleBehaviorType?](#ChartAxisAutoScaleBehaviorType)|Settings for automatic scaling +[FixedScaleMultipleStackedMeasuresBoundaryValues](UI.xml#L852)|[FixedScaleMultipleStackedMeasuresBoundaryValuesType?](#FixedScaleMultipleStackedMeasuresBoundaryValuesType)|Boundary values for fixed scaling of a stacking chart type with multiple measures -## [ChartAxisScaleBehaviorType](UI.xml#L850) +## [ChartAxisScaleBehaviorType](UI.xml#L857) Member|Value|Description :-----|----:|:---------- -[AutoScale](UI.xml#L851)|0|Value axes scale automatically -[FixedScale](UI.xml#L854)|1|Fixed minimum and maximum values are applied, which are derived from the @UI.MeasureAttributes.DataPoint/MinimumValue and .../MaximumValue annotation by default. For stacking chart types with multiple measures, they are taken from ChartAxisScalingType/FixedScaleMultipleStackedMeasuresBoundaryValues. +[AutoScale](UI.xml#L858)|0|Value axes scale automatically +[FixedScale](UI.xml#L861)|1|Fixed minimum and maximum values are applied, which are derived from the @UI.MeasureAttributes.DataPoint/MinimumValue and .../MaximumValue annotation by default. For stacking chart types with multiple measures, they are taken from ChartAxisScalingType/FixedScaleMultipleStackedMeasuresBoundaryValues. -## [ChartAxisAutoScaleBehaviorType](UI.xml#L863) +## [ChartAxisAutoScaleBehaviorType](UI.xml#L870) Property|Type|Description :-------|:---|:---------- -[ZeroAlwaysVisible](UI.xml#L864)|Boolean|Forces the value axis to always display the zero value -[DataScope](UI.xml#L867)|[ChartAxisAutoScaleDataScopeType](#ChartAxisAutoScaleDataScopeType)|Determines the automatic scaling +[ZeroAlwaysVisible](UI.xml#L871)|Boolean|Forces the value axis to always display the zero value +[DataScope](UI.xml#L874)|[ChartAxisAutoScaleDataScopeType](#ChartAxisAutoScaleDataScopeType)|Determines the automatic scaling -## [ChartAxisAutoScaleDataScopeType](UI.xml#L872) +## [ChartAxisAutoScaleDataScopeType](UI.xml#L879) Member|Value|Description :-----|----:|:---------- -[DataSet](UI.xml#L873)|0|Minimum and maximum axes values are determined from the entire data set -[VisibleData](UI.xml#L876)|1|Minimum and maximum axes values are determined from the currently visible data. Scrolling will change the scale. +[DataSet](UI.xml#L880)|0|Minimum and maximum axes values are determined from the entire data set +[VisibleData](UI.xml#L883)|1|Minimum and maximum axes values are determined from the currently visible data. Scrolling will change the scale. -## [FixedScaleMultipleStackedMeasuresBoundaryValuesType](UI.xml#L881) +## [FixedScaleMultipleStackedMeasuresBoundaryValuesType](UI.xml#L888) Property|Type|Description :-------|:---|:---------- -[MinimumValue](UI.xml#L882)|Decimal|Minimum value on value axes -[MaximumValue](UI.xml#L885)|Decimal|Maximum value on value axes +[MinimumValue](UI.xml#L889)|Decimal|Minimum value on value axes +[MaximumValue](UI.xml#L892)|Decimal|Maximum value on value axes -## [ChartDimensionAttributeType](UI.xml#L890) +## [ChartDimensionAttributeType](UI.xml#L897) Property|Type|Description :-------|:---|:---------- -[Dimension](UI.xml#L891)|PropertyPath?| -[Role](UI.xml#L892)|[ChartDimensionRoleType?](#ChartDimensionRoleType)| -[HierarchyLevel](UI.xml#L893) *([Experimental](Common.md#Experimental))*|Int32?|For a dimension with a hierarchy, members are selected from this level. The root node of the hierarchy is at level 0. -[ValuesForSequentialColorLevels](UI.xml#L897) *([Experimental](Common.md#Experimental))*|\[String\]|All values in this collection should be assigned to levels of the same color. -[EmphasizedValues](UI.xml#L901) *([Experimental](Common.md#Experimental))*|\[String\]|All values in this collection should be emphasized. -[EmphasisLabels](UI.xml#L905) *([Experimental](Common.md#Experimental))*|[EmphasisLabelType?](#EmphasisLabelType)|Assign a label to values with an emphasized representation. This is required, if more than one emphasized value has been specified. +[Dimension](UI.xml#L898)|PropertyPath?| +[Role](UI.xml#L899)|[ChartDimensionRoleType?](#ChartDimensionRoleType)| +[HierarchyLevel](UI.xml#L900) *([Experimental](Common.md#Experimental))*|Int32?|For a dimension with a hierarchy, members are selected from this level. The root node of the hierarchy is at level 0. +[ValuesForSequentialColorLevels](UI.xml#L904) *([Experimental](Common.md#Experimental))*|\[String\]|All values in this collection should be assigned to levels of the same color. +[EmphasizedValues](UI.xml#L908) *([Experimental](Common.md#Experimental))*|\[String\]|All values in this collection should be emphasized. +[EmphasisLabels](UI.xml#L912) *([Experimental](Common.md#Experimental))*|[EmphasisLabelType?](#EmphasisLabelType)|Assign a label to values with an emphasized representation. This is required, if more than one emphasized value has been specified. -## [ChartMeasureAttributeType](UI.xml#L911) +## [ChartMeasureAttributeType](UI.xml#L918) Exactly one of `Measure` and `DynamicMeasure` must be present Property|Type|Description :-------|:---|:---------- -[Measure](UI.xml#L913)|PropertyPath?| -[DynamicMeasure](UI.xml#L916)|AnnotationPath?|Dynamic property introduced by an annotation and used as a measure in a chart
If the annotation referenced by an annotation path does not apply to the same collection of entities as the one being visualized according to the `UI.Chart` annotation, the annotation path MUST be silently ignored.
Allowed terms: -[Role](UI.xml#L929)|[ChartMeasureRoleType?](#ChartMeasureRoleType)| -[DataPoint](UI.xml#L930)|AnnotationPath?|Annotation path MUST end in @UI.DataPoint and the data point's Value MUST be the same property as in Measure
Allowed terms: -[UseSequentialColorLevels](UI.xml#L938) *([Experimental](Common.md#Experimental))*|Boolean|All measures for which this setting is true should be assigned to levels of the same color. +[Measure](UI.xml#L920)|PropertyPath?| +[DynamicMeasure](UI.xml#L923)|AnnotationPath?|Dynamic property introduced by an annotation and used as a measure in a chart
If the annotation referenced by an annotation path does not apply to the same collection of entities as the one being visualized according to the `UI.Chart` annotation, the annotation path MUST be silently ignored.
Allowed terms: +[Role](UI.xml#L936)|[ChartMeasureRoleType?](#ChartMeasureRoleType)| +[DataPoint](UI.xml#L937)|AnnotationPath?|Annotation path MUST end in @UI.DataPoint and the data point's Value MUST be the same property as in Measure
Allowed terms: +[UseSequentialColorLevels](UI.xml#L945) *([Experimental](Common.md#Experimental))*|Boolean|All measures for which this setting is true should be assigned to levels of the same color. -## [ChartDimensionRoleType](UI.xml#L944) +## [ChartDimensionRoleType](UI.xml#L951) Member|Value|Description :-----|----:|:---------- -[Category](UI.xml#L945)|0| -[Series](UI.xml#L946)|1| -[Category2](UI.xml#L947)|2| +[Category](UI.xml#L952)|0| +[Series](UI.xml#L953)|1| +[Category2](UI.xml#L954)|2| -## [ChartMeasureRoleType](UI.xml#L950) +## [ChartMeasureRoleType](UI.xml#L957) Member|Value|Description :-----|----:|:---------- -[Axis1](UI.xml#L951)|0| -[Axis2](UI.xml#L952)|1| -[Axis3](UI.xml#L953)|2| +[Axis1](UI.xml#L958)|0| +[Axis2](UI.xml#L959)|1| +[Axis3](UI.xml#L960)|2| -## [EmphasisLabelType](UI.xml#L956) *([Experimental](Common.md#Experimental))* +## [EmphasisLabelType](UI.xml#L963) *([Experimental](Common.md#Experimental))* Assigns a label to the set of emphasized values and optionally also for non-emphasized values. This information can be used for semantic coloring. Property|Type|Description :-------|:---|:---------- -[EmphasizedValuesLabel](UI.xml#L959)|String| -[NonEmphasizedValuesLabel](UI.xml#L960)|String?| +[EmphasizedValuesLabel](UI.xml#L966)|String| +[NonEmphasizedValuesLabel](UI.xml#L967)|String?| -## [ValueCriticalityType](UI.xml#L967) *([Experimental](Common.md#Experimental))* +## [ValueCriticalityType](UI.xml#L974) *([Experimental](Common.md#Experimental))* Assigns a fixed criticality to a primitive value. This information can be used for semantic coloring. Property|Type|Description :-------|:---|:---------- -[Value](UI.xml#L970)|PrimitiveType?|MUST be a fixed value of primitive type -[Criticality](UI.xml#L973)|[CriticalityType?](#CriticalityType)| +[Value](UI.xml#L977)|PrimitiveType?|MUST be a fixed value of primitive type +[Criticality](UI.xml#L980)|[CriticalityType?](#CriticalityType)| -## [CriticalityLabelType](UI.xml#L987) *([Experimental](Common.md#Experimental))* +## [CriticalityLabelType](UI.xml#L994) *([Experimental](Common.md#Experimental))* Assigns a label to a criticality. This information can be used for semantic coloring. Property|Type|Description :-------|:---|:---------- -[Criticality](UI.xml#L990)|[CriticalityType](#CriticalityType)| -[Label](UI.xml#L991)|String|Criticality label +[Criticality](UI.xml#L997)|[CriticalityType](#CriticalityType)| +[Label](UI.xml#L998)|String|Criticality label -## [*Facet*](UI.xml#L1024) +## [*Facet*](UI.xml#L1031) Abstract base type for facets **Derived Types:** @@ -659,8 +615,8 @@ Abstract base type for facets Property|Type|Description :-------|:---|:---------- -[Label](UI.xml#L1032)|String?|Facet label -[ID](UI.xml#L1036)|String?|Unique identifier of a facet. ID should be stable, as long as the perceived semantics of the facet is unchanged. +[Label](UI.xml#L1039)|String?|Facet label +[ID](UI.xml#L1043)|String?|Unique identifier of a facet. ID should be stable, as long as the perceived semantics of the facet is unchanged. **Applicable Annotation Terms:** @@ -668,14 +624,14 @@ Property|Type|Description - [PartOfPreview](#PartOfPreview) -## [CollectionFacet](UI.xml#L1040): [Facet](#Facet) +## [CollectionFacet](UI.xml#L1047): [Facet](#Facet) Collection of facets Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1032)|String?|Facet label -[*ID*](UI.xml#L1036)|String?|Unique identifier of a facet. ID should be stable, as long as the perceived semantics of the facet is unchanged. -[Facets](UI.xml#L1042)|\[[Facet](#Facet)\]|Nested facets. An empty collection may be used as a placeholder for content added via extension points. +[*Label*](UI.xml#L1039)|String?|Facet label +[*ID*](UI.xml#L1043)|String?|Unique identifier of a facet. ID should be stable, as long as the perceived semantics of the facet is unchanged. +[Facets](UI.xml#L1049)|\[[Facet](#Facet)\]|Nested facets. An empty collection may be used as a placeholder for content added via extension points. **Applicable Annotation Terms:** @@ -683,14 +639,14 @@ Property|Type|Description - [PartOfPreview](#PartOfPreview) -## [ReferenceFacet](UI.xml#L1046): [Facet](#Facet) +## [ReferenceFacet](UI.xml#L1053): [Facet](#Facet) Facet that refers to a thing perspective, e.g. LineItem Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1032)|String?|Facet label -[*ID*](UI.xml#L1036)|String?|Unique identifier of a facet. ID should be stable, as long as the perceived semantics of the facet is unchanged. -[Target](UI.xml#L1048)|AnnotationPath|Referenced information: Communication.Contact, Communication.Address, or a term that is tagged with UI.ThingPerspective, e.g. UI.StatusInfo, UI.LineItem, UI.Identification, UI.FieldGroup, UI.Badge
Allowed terms: +[*Label*](UI.xml#L1039)|String?|Facet label +[*ID*](UI.xml#L1043)|String?|Unique identifier of a facet. ID should be stable, as long as the perceived semantics of the facet is unchanged. +[Target](UI.xml#L1055)|AnnotationPath|Referenced information: Communication.Contact, Communication.Address, or a term that is tagged with UI.ThingPerspective, e.g. UI.StatusInfo, UI.LineItem, UI.Identification, UI.FieldGroup, UI.Badge
Allowed terms: **Applicable Annotation Terms:** @@ -698,15 +654,15 @@ Property|Type|Description - [PartOfPreview](#PartOfPreview) -## [ReferenceURLFacet](UI.xml#L1075): [Facet](#Facet) +## [ReferenceURLFacet](UI.xml#L1082): [Facet](#Facet) Facet that refers to a URL Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1032)|String?|Facet label -[*ID*](UI.xml#L1036)|String?|Unique identifier of a facet. ID should be stable, as long as the perceived semantics of the facet is unchanged. -[Url](UI.xml#L1077)|URL|URL of referenced information
Can be annotated with: -[UrlContentType](UI.xml#L1086)|MediaType?|Media type of referenced information +[*Label*](UI.xml#L1039)|String?|Facet label +[*ID*](UI.xml#L1043)|String?|Unique identifier of a facet. ID should be stable, as long as the perceived semantics of the facet is unchanged. +[Url](UI.xml#L1084)|URL|URL of referenced information
Can be annotated with: +[UrlContentType](UI.xml#L1093)|MediaType?|Media type of referenced information **Applicable Annotation Terms:** @@ -714,51 +670,51 @@ Property|Type|Description - [PartOfPreview](#PartOfPreview) -## [SelectionPresentationVariantType](UI.xml#L1099) +## [SelectionPresentationVariantType](UI.xml#L1106) Property|Type|Description :-------|:---|:---------- -[ID](UI.xml#L1100)|String?|Optional identifier to reference this variant from an external context -[Text](UI.xml#L1105)|String?|Name of the bundling variant -[SelectionVariant](UI.xml#L1109)|[SelectionVariantType](#SelectionVariantType)|Selection variant, either specified inline or referencing another annotation via Path -[PresentationVariant](UI.xml#L1112)|[PresentationVariantType](#PresentationVariantType)|Presentation variant, either specified inline or referencing another annotation via Path +[ID](UI.xml#L1107)|String?|Optional identifier to reference this variant from an external context +[Text](UI.xml#L1112)|String?|Name of the bundling variant +[SelectionVariant](UI.xml#L1116)|[SelectionVariantType](#SelectionVariantType)|Selection variant, either specified inline or referencing another annotation via Path +[PresentationVariant](UI.xml#L1119)|[PresentationVariantType](#PresentationVariantType)|Presentation variant, either specified inline or referencing another annotation via Path -## [PresentationVariantType](UI.xml#L1123) +## [PresentationVariantType](UI.xml#L1130) Property|Type|Description :-------|:---|:---------- -[ID](UI.xml#L1124)|String?|Optional identifier to reference this variant from an external context -[Text](UI.xml#L1127)|String?|Name of the presentation variant -[MaxItems](UI.xml#L1131)|Int32?|Maximum number of items that should be included in the result -[SortOrder](UI.xml#L1134)|\[[SortOrderType](Common.md#SortOrderType)\]|Collection can be provided inline or as a reference to a Common.SortOrder annotation via Path -[GroupBy](UI.xml#L1137)|\[PropertyPath\]|Sequence of groupable properties p1, p2, ... defining how the result is composed of instances representing groups, one for each combination of value properties in the queried collection. The sequence specifies a certain level of aggregation for the queried collection, and every group instance will provide aggregated values for properties that are aggregatable. Moreover, the series of sub-sequences (p1), (p1, p2), ... forms a leveled hierarchy, which may become relevant in combination with `InitialExpansionLevel`. -[TotalBy](UI.xml#L1146)|\[PropertyPath\]|Sub-sequence q1, q2, ... of properties p1, p2, ... specified in GroupBy. With this, additional levels of aggregation are requested in addition to the most granular level defined by GroupBy: Every element in the series of sub-sequences (q1), (q1, q2), ... introduces an additional aggregation level included in the result. -[Total](UI.xml#L1153)|\[PropertyPath\]|Aggregatable properties for which aggregated values should be provided for the additional aggregation levels specified in TotalBy. -[DynamicTotal](UI.xml#L1159)|\[AnnotationPath\]|Dynamic properties introduced by annotations for which aggregated values should be provided for the additional aggregation levels specified in TotalBy
If the annotation referenced by an annotation path does not apply to the same collection of entities as the one being presented according to the `UI.PresentationVariant` annotation, the annotation path MUST be silently ignored.
Allowed terms: -[IncludeGrandTotal](UI.xml#L1172)|Boolean|Result should include a grand total for the properties specified in Total -[InitialExpansionLevel](UI.xml#L1175)|Int32|Level up to which the hierarchy defined for the queried collection should be expanded initially. The hierarchy may be implicitly imposed by the sequence of the GroupBy, or by an explicit hierarchy annotation. -[Visualizations](UI.xml#L1181)|\[AnnotationPath\]|Lists available visualization types. Currently supported types are `UI.LineItem`, `UI.Chart`, and `UI.DataPoint`. For each type, no more than a single annotation is meaningful. Multiple instances of the same visualization type shall be modeled with different presentation variants. A reference to `UI.Lineitem` should always be part of the collection (least common denominator for renderers). The first entry of the collection is the default visualization.
Allowed terms: -[RecursiveHierarchyQualifier](UI.xml#L1198) *([Experimental](Common.md#Experimental))*|[HierarchyQualifier?](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#HierarchyQualifier)|Qualifier of the recursive hierarchy that should be applied to the Visualization -[RequestAtLeast](UI.xml#L1202)|\[PropertyPath\]|Properties that should always be included in the result of the queried collection
Properties in `RequestAtLeast` must occur either in the `$select` clause of an OData request or among the grouping properties in an `$apply=groupby((grouping properties),...)` clause of an aggregating OData request. -[SelectionFields](UI.xml#L1225) *([Experimental](Common.md#Experimental))*|\[PropertyPath\]|Properties that should be presented for filtering a collection of entities. Can be provided inline or as a reference to a `UI.SelectionFields` annotation via Path. +[ID](UI.xml#L1131)|String?|Optional identifier to reference this variant from an external context +[Text](UI.xml#L1134)|String?|Name of the presentation variant +[MaxItems](UI.xml#L1138)|Int32?|Maximum number of items that should be included in the result +[SortOrder](UI.xml#L1141)|\[[SortOrderType](Common.md#SortOrderType)\]|Collection can be provided inline or as a reference to a Common.SortOrder annotation via Path +[GroupBy](UI.xml#L1144)|\[PropertyPath\]|Sequence of groupable properties p1, p2, ... defining how the result is composed of instances representing groups, one for each combination of value properties in the queried collection. The sequence specifies a certain level of aggregation for the queried collection, and every group instance will provide aggregated values for properties that are aggregatable. Moreover, the series of sub-sequences (p1), (p1, p2), ... forms a leveled hierarchy, which may become relevant in combination with `InitialExpansionLevel`. +[TotalBy](UI.xml#L1153)|\[PropertyPath\]|Sub-sequence q1, q2, ... of properties p1, p2, ... specified in GroupBy. With this, additional levels of aggregation are requested in addition to the most granular level defined by GroupBy: Every element in the series of sub-sequences (q1), (q1, q2), ... introduces an additional aggregation level included in the result. +[Total](UI.xml#L1160)|\[PropertyPath\]|Aggregatable properties for which aggregated values should be provided for the additional aggregation levels specified in TotalBy. +[DynamicTotal](UI.xml#L1166)|\[AnnotationPath\]|Dynamic properties introduced by annotations for which aggregated values should be provided for the additional aggregation levels specified in TotalBy
If the annotation referenced by an annotation path does not apply to the same collection of entities as the one being presented according to the `UI.PresentationVariant` annotation, the annotation path MUST be silently ignored.
Allowed terms: +[IncludeGrandTotal](UI.xml#L1179)|Boolean|Result should include a grand total for the properties specified in Total +[InitialExpansionLevel](UI.xml#L1182)|Int32|Level up to which the hierarchy defined for the queried collection should be expanded initially. The hierarchy may be implicitly imposed by the sequence of the GroupBy, or by an explicit hierarchy annotation. +[Visualizations](UI.xml#L1188)|\[AnnotationPath\]|Lists available visualization types. Currently supported types are `UI.LineItem`, `UI.Chart`, and `UI.DataPoint`. For each type, no more than a single annotation is meaningful. Multiple instances of the same visualization type shall be modeled with different presentation variants. A reference to `UI.Lineitem` should always be part of the collection (least common denominator for renderers). The first entry of the collection is the default visualization.
Allowed terms: +[RecursiveHierarchyQualifier](UI.xml#L1205) *([Experimental](Common.md#Experimental))*|[HierarchyQualifier?](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#HierarchyQualifier)|Qualifier of the recursive hierarchy that should be applied to the Visualization +[RequestAtLeast](UI.xml#L1209)|\[PropertyPath\]|Properties that should always be included in the result of the queried collection
Properties in `RequestAtLeast` must occur either in the `$select` clause of an OData request or among the grouping properties in an `$apply=groupby((grouping properties),...)` clause of an aggregating OData request. +[SelectionFields](UI.xml#L1232) *([Experimental](Common.md#Experimental))*|\[PropertyPath\]|Properties that should be presented for filtering a collection of entities. Can be provided inline or as a reference to a `UI.SelectionFields` annotation via Path. -## [SelectionVariantType](UI.xml#L1239) +## [SelectionVariantType](UI.xml#L1246) Property|Type|Description :-------|:---|:---------- -[ID](UI.xml#L1240)|String?|May contain identifier to reference this instance from an external context -[Text](UI.xml#L1245)|String?|Name of the selection variant -[Parameters](UI.xml#L1249)|\[[ParameterAbstract](#ParameterAbstract)\]|Parameters of the selection variant -[FilterExpression](UI.xml#L1252)|String?|Filter string for query part of URL, without `$filter=` -[SelectOptions](UI.xml#L1257)|\[[SelectOptionType](#SelectOptionType)\]|ABAP Select Options Pattern +[ID](UI.xml#L1247)|String?|May contain identifier to reference this instance from an external context +[Text](UI.xml#L1252)|String?|Name of the selection variant +[Parameters](UI.xml#L1256)|\[[ParameterAbstract](#ParameterAbstract)\]|Parameters of the selection variant +[FilterExpression](UI.xml#L1259)|String?|Filter string for query part of URL, without `$filter=` +[SelectOptions](UI.xml#L1264)|\[[SelectOptionType](#SelectOptionType)\]|ABAP Select Options Pattern -## [*ParameterAbstract*](UI.xml#L1264) +## [*ParameterAbstract*](UI.xml#L1271) Key property of a parameter entity type **Derived Types:** @@ -766,137 +722,134 @@ Key property of a parameter entity type - [IntervalParameter](#IntervalParameter) -## [Parameter](UI.xml#L1267): [ParameterAbstract](#ParameterAbstract) +## [Parameter](UI.xml#L1274): [ParameterAbstract](#ParameterAbstract) Single-valued parameter Property|Type|Description :-------|:---|:---------- -[PropertyName](UI.xml#L1269)|PropertyPath|Path to a key property of a parameter entity type -[PropertyValue](UI.xml#L1272)|PrimitiveType|Value for the key property +[PropertyName](UI.xml#L1276)|PropertyPath|Path to a key property of a parameter entity type +[PropertyValue](UI.xml#L1279)|PrimitiveType|Value for the key property -## [IntervalParameter](UI.xml#L1276): [ParameterAbstract](#ParameterAbstract) +## [IntervalParameter](UI.xml#L1283): [ParameterAbstract](#ParameterAbstract) Interval parameter formed with a 'from' and a 'to' property Property|Type|Description :-------|:---|:---------- -[PropertyNameFrom](UI.xml#L1278)|PropertyPath|Path to the 'from' property of a parameter entity type -[PropertyValueFrom](UI.xml#L1281)|PrimitiveType|Value for the 'from' property -[PropertyNameTo](UI.xml#L1284)|PropertyPath|Path to the 'to' property of a parameter entity type -[PropertyValueTo](UI.xml#L1287)|PrimitiveType|Value for the 'to' property +[PropertyNameFrom](UI.xml#L1285)|PropertyPath|Path to the 'from' property of a parameter entity type +[PropertyValueFrom](UI.xml#L1288)|PrimitiveType|Value for the 'from' property +[PropertyNameTo](UI.xml#L1291)|PropertyPath|Path to the 'to' property of a parameter entity type +[PropertyValueTo](UI.xml#L1294)|PrimitiveType|Value for the 'to' property -## [SelectOptionType](UI.xml#L1292) +## [SelectOptionType](UI.xml#L1299) List of value ranges for a single property Exactly one of `PropertyName` and `DynamicPropertyName` must be present Property|Type|Description :-------|:---|:---------- -[PropertyName](UI.xml#L1295)|PropertyPath?|Path to the property -[DynamicPropertyName](UI.xml#L1307)|AnnotationPath?|Dynamic property introduced by annotations for which value ranges are specified
If the annotation referenced by the annotation path does not apply to the same collection of entities as the one being filtered according to the `UI.SelectionVariant` annotation, this instance of `UI.SelectionVariant/SelectOptions` MUST be silently ignored. For an example, see the `UI.SelectionVariant` annotation in the [example](../examples/DynamicProperties-sample.xml).
Allowed terms: -[Ranges](UI.xml#L1321)|\[[SelectionRangeType](#SelectionRangeType)\]|List of value ranges +[PropertyName](UI.xml#L1302)|PropertyPath?|Path to the property +[DynamicPropertyName](UI.xml#L1314)|AnnotationPath?|Dynamic property introduced by annotations for which value ranges are specified
If the annotation referenced by the annotation path does not apply to the same collection of entities as the one being filtered according to the `UI.SelectionVariant` annotation, this instance of `UI.SelectionVariant/SelectOptions` MUST be silently ignored. For an example, see the `UI.SelectionVariant` annotation in the [example](../examples/DynamicProperties-sample.xml).
Allowed terms: +[Ranges](UI.xml#L1328)|\[[SelectionRangeType](#SelectionRangeType)\]|List of value ranges -## [SelectionRangeType](UI.xml#L1326) +## [SelectionRangeType](UI.xml#L1333) Value range. If the range option only requires a single value, the value must be in the property Low Property|Type|Description :-------|:---|:---------- -[Sign](UI.xml#L1330)|[SelectionRangeSignType](#SelectionRangeSignType)|Include or exclude values -[Option](UI.xml#L1333)|[SelectionRangeOptionType](#SelectionRangeOptionType)|Comparison operator -[Low](UI.xml#L1336)|PrimitiveType|Single value or lower interval boundary -[High](UI.xml#L1339)|PrimitiveType?|Upper interval boundary +[Sign](UI.xml#L1337)|[SelectionRangeSignType](#SelectionRangeSignType)|Include or exclude values +[Option](UI.xml#L1340)|[SelectionRangeOptionType](#SelectionRangeOptionType)|Comparison operator +[Low](UI.xml#L1343)|PrimitiveType|Single value or lower interval boundary +[High](UI.xml#L1346)|PrimitiveType?|Upper interval boundary -## [SelectionRangeSignType](UI.xml#L1344) +## [SelectionRangeSignType](UI.xml#L1351) Member|Value|Description :-----|----:|:---------- -[I](UI.xml#L1345)|0|Inclusive -[E](UI.xml#L1348)|1|Exclusive +[I](UI.xml#L1352)|0|Inclusive +[E](UI.xml#L1355)|1|Exclusive -## [SelectionRangeOptionType](UI.xml#L1353) +## [SelectionRangeOptionType](UI.xml#L1360) Comparison operator Member|Value|Description :-----|----:|:---------- -[EQ](UI.xml#L1355)|0|Equal to -[BT](UI.xml#L1358)|1|Between -[CP](UI.xml#L1361)|2|Contains pattern -[LE](UI.xml#L1364)|3|Less than or equal to -[GE](UI.xml#L1367)|4|Greater than or equal to -[NE](UI.xml#L1370)|5|Not equal to -[NB](UI.xml#L1373)|6|Not between -[NP](UI.xml#L1376)|7|Does not contain pattern -[GT](UI.xml#L1379)|8|Greater than -[LT](UI.xml#L1382)|9|Less than +[EQ](UI.xml#L1362)|0|Equal to +[BT](UI.xml#L1365)|1|Between +[CP](UI.xml#L1368)|2|Contains pattern +[LE](UI.xml#L1371)|3|Less than or equal to +[GE](UI.xml#L1374)|4|Greater than or equal to +[NE](UI.xml#L1377)|5|Not equal to +[NB](UI.xml#L1380)|6|Not between +[NP](UI.xml#L1383)|7|Does not contain pattern +[GT](UI.xml#L1386)|8|Greater than +[LT](UI.xml#L1389)|9|Less than -## [InputMaskType](UI.xml#L1450) *([Experimental](Common.md#Experimental))* +## [InputMaskType](UI.xml#L1457) *([Experimental](Common.md#Experimental))* Property|Type|Description :-------|:---|:---------- -[Mask](UI.xml#L1452)|String|The mask to be applied to the property or the parameter -[PlaceholderSymbol](UI.xml#L1455)|String|A single character symbol to be shown where the user can type a character -[Rules](UI.xml#L1458)|\[[InputMaskRuleType](#InputMaskRuleType)\]|Rules that define valid values for one symbol in the mask
The following rules are defined as default and don't need to be listed here: * = ., C = [a-zA-Z], 9 = [0-9] +[Mask](UI.xml#L1459)|String|The mask to be applied to the property or the parameter +[PlaceholderSymbol](UI.xml#L1462)|String|A single character symbol to be shown where the user can type a character +[Rules](UI.xml#L1465)|\[[InputMaskRuleType](#InputMaskRuleType)\]|Rules that define valid values for one symbol in the mask
The following rules are defined as default and don't need to be listed here: * = ., C = [a-zA-Z], 9 = [0-9] -## [InputMaskRuleType](UI.xml#L1465) *([Experimental](Common.md#Experimental))* +## [InputMaskRuleType](UI.xml#L1472) *([Experimental](Common.md#Experimental))* Property|Type|Description :-------|:---|:---------- -[MaskSymbol](UI.xml#L1467)|String|A symbol in the mask that stands for a regular expression which must be matched by the user input in every position where this symbol occurs -[RegExp](UI.xml#L1470)|String|Regular expression that defines the valid values for the mask symbol +[MaskSymbol](UI.xml#L1474)|String|A symbol in the mask that stands for a regular expression which must be matched by the user input in every position where this symbol occurs +[RegExp](UI.xml#L1477)|String|Regular expression that defines the valid values for the mask symbol -## [TextArrangementType](UI.xml#L1483) +## [TextArrangementType](UI.xml#L1490) Member|Value|Description :-----|----:|:---------- -[TextFirst](UI.xml#L1484)|0|Text is first, followed by the code/ID (e.g. in parentheses) -[TextLast](UI.xml#L1487)|1|Code/ID is first, followed by the text (e.g. separated by a dash) -[TextSeparate](UI.xml#L1490)|2|Code/ID and text are represented separately (code/ID will be shown and text can be visualized in a separate place) -[TextOnly](UI.xml#L1493)|3|Only text is represented, code/ID is hidden (e.g. for UUIDs) +[TextFirst](UI.xml#L1491)|0|Text is first, followed by the code/ID (e.g. in parentheses) +[TextLast](UI.xml#L1494)|1|Code/ID is first, followed by the text (e.g. separated by a dash) +[TextSeparate](UI.xml#L1497)|2|Code/ID and text are represented separately (code/ID will be shown and text can be visualized in a separate place) +[TextOnly](UI.xml#L1500)|3|Only text is represented, code/ID is hidden (e.g. for UUIDs) -## [NoteType](UI.xml#L1539) *([Experimental](Common.md#Experimental))* +## [NoteType](UI.xml#L1546) *([Experimental](Common.md#Experimental))* Property|Type|Description :-------|:---|:---------- -[Title](UI.xml#L1541)|String?|Title of the note
The title of a note is hidden with an annotation `@UI.Note/Title/@UI.Hidden`, not with an annotation on the property targeted by `@UI.Note/Title`.
Can be annotated with: -[Content](UI.xml#L1553)|String|Content of the note, as a string
The property targeted by `@UI.Note/Content` must be annotated with `Core.MediaType` and may be annotated with `Common.SAPObjectNodeTypeReference`. When it is tagged with `Core.IsLanguageDependent`, another property of the same entity type that is tagged with [`Common.IsLanguageIdentifier`](Common.md#IsLanguageIdentifier) determines the language of the note.
Can be annotated with: -[Type](UI.xml#L1569)|String|A type used for grouping notes -[MaximalLength](UI.xml#L1572)|Int32?|Type-specific maximal length of the content of the note -[MultipleNotes](UI.xml#L1575)|Boolean|Whether the type allows multiple notes for one object +[Title](UI.xml#L1548)|String?|Title of the note
The title of a note is hidden with an annotation `@UI.Note/Title/@UI.Hidden`, not with an annotation on the property targeted by `@UI.Note/Title`.
Can be annotated with: +[Content](UI.xml#L1560)|String|Content of the note, as a string
The property targeted by `@UI.Note/Content` must be annotated with `Core.MediaType` and may be annotated with `Common.SAPObjectNodeTypeReference`. When it is tagged with `Core.IsLanguageDependent`, another property of the same entity type that is tagged with [`Common.IsLanguageIdentifier`](Common.md#IsLanguageIdentifier) determines the language of the note.
Can be annotated with: +[Type](UI.xml#L1576)|String|A type used for grouping notes +[MaximalLength](UI.xml#L1579)|Int32?|Type-specific maximal length of the content of the note +[MultipleNotes](UI.xml#L1582)|Boolean|Whether the type allows multiple notes for one object -## [ImportanceType](UI.xml#L1583) +## [ImportanceType](UI.xml#L1590) Member|Value|Description :-----|----:|:---------- -[High](UI.xml#L1584)|0|High importance -[Medium](UI.xml#L1587)|1|Medium importance -[Low](UI.xml#L1590)|2|Low importance +[High](UI.xml#L1591)|0|High importance +[Medium](UI.xml#L1594)|1|Medium importance +[Low](UI.xml#L1597)|2|Low importance -## [*DataFieldAbstract*](UI.xml#L1658) +## [*DataFieldAbstract*](UI.xml#L1665) Elementary building block that represents a piece of data and/or allows triggering an action By using the applicable terms UI.Hidden, UI.Importance or HTML5.CssDefaults, the visibility, the importance and and the default css settings (as the width) of the data field can be influenced. **Derived Types:** -- *[DataFieldGridAbstract](#DataFieldGridAbstract)* - - [DataFieldMeasures](#DataFieldMeasures) - - [DataFieldDimension](#DataFieldDimension) - [DataFieldForAnnotation](#DataFieldForAnnotation) - *[DataFieldForActionAbstract](#DataFieldForActionAbstract)* - [DataFieldForAction](#DataFieldForAction) @@ -911,10 +864,10 @@ By using the applicable terms UI.Hidden, UI.Importance or HTML5.CssDefaults, the Property|Type|Description :-------|:---|:---------- -[Label](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[Criticality](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[CriticalityRepresentation](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[IconUrl](UI.xml#L1684)|URL?|Optional icon +[Label](UI.xml#L1681)|String?|A short, human-readable text suitable for labels and captions in UIs +[Criticality](UI.xml#L1685)|[CriticalityType?](#CriticalityType)|Criticality of the data field value +[CriticalityRepresentation](UI.xml#L1688)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon +[IconUrl](UI.xml#L1691)|URL?|Optional icon **Applicable Annotation Terms:** @@ -926,26 +879,26 @@ Property|Type|Description - [FieldControl](Common.md#FieldControl) -## [CriticalityRepresentationType](UI.xml#L1690) +## [CriticalityRepresentationType](UI.xml#L1697) Member|Value|Description :-----|----:|:---------- -[WithIcon](UI.xml#L1691)|0|Criticality is represented with an icon -[WithoutIcon](UI.xml#L1694)|1|Criticality is represented without icon, e.g. only via text color -[OnlyIcon](UI.xml#L1697) *([Experimental](Common.md#Experimental))*|2|Criticality is represented only by using an icon +[WithIcon](UI.xml#L1698)|0|Criticality is represented with an icon +[WithoutIcon](UI.xml#L1701)|1|Criticality is represented without icon, e.g. only via text color +[OnlyIcon](UI.xml#L1704) *([Experimental](Common.md#Experimental))*|2|Criticality is represented only by using an icon -## [DataFieldForAnnotation](UI.xml#L1703): [DataFieldAbstract](#DataFieldAbstract) +## [DataFieldForAnnotation](UI.xml#L1710): [DataFieldAbstract](#DataFieldAbstract) A structured piece of data described by an annotation Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon -[Target](UI.xml#L1705)|AnnotationPath|Target MUST reference an annotation of terms Communication.Contact, Communication.Address, UI.DataPoint, UI.Chart, UI.FieldGroup, or UI.ConnectedFields
Allowed terms: +[*Label*](UI.xml#L1681)|String?|A short, human-readable text suitable for labels and captions in UIs +[*Criticality*](UI.xml#L1685)|[CriticalityType?](#CriticalityType)|Criticality of the data field value +[*CriticalityRepresentation*](UI.xml#L1688)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon +[*IconUrl*](UI.xml#L1691)|URL?|Optional icon +[Target](UI.xml#L1712)|AnnotationPath|Target MUST reference an annotation of terms Communication.Contact, Communication.Address, UI.DataPoint, UI.Chart, UI.FieldGroup, or UI.ConnectedFields
Allowed terms: **Applicable Annotation Terms:** @@ -957,7 +910,7 @@ Property|Type|Description - [FieldControl](Common.md#FieldControl) -## [*DataFieldForActionAbstract*](UI.xml#L1720): [DataFieldAbstract](#DataFieldAbstract) +## [*DataFieldForActionAbstract*](UI.xml#L1727): [DataFieldAbstract](#DataFieldAbstract) Triggers an action **Derived Types:** @@ -966,12 +919,12 @@ Triggers an action Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon -[Inline](UI.xml#L1722)|Boolean|Action should be placed close to (or even inside) the visualized term -[Determining](UI.xml#L1725)|Boolean|Determines whether the action completes a process step (e.g. approve, reject). +[*Label*](UI.xml#L1681)|String?|A short, human-readable text suitable for labels and captions in UIs +[*Criticality*](UI.xml#L1685)|[CriticalityType?](#CriticalityType)|Criticality of the data field value +[*CriticalityRepresentation*](UI.xml#L1688)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon +[*IconUrl*](UI.xml#L1691)|URL?|Optional icon +[Inline](UI.xml#L1729)|Boolean|Action should be placed close to (or even inside) the visualized term +[Determining](UI.xml#L1732)|Boolean|Determines whether the action completes a process step (e.g. approve, reject). **Applicable Annotation Terms:** @@ -983,21 +936,21 @@ Property|Type|Description - [FieldControl](Common.md#FieldControl) -## [DataFieldForAction](UI.xml#L1730): [DataFieldForActionAbstract](#DataFieldForActionAbstract) +## [DataFieldForAction](UI.xml#L1737): [DataFieldForActionAbstract](#DataFieldForActionAbstract) Triggers an OData action The action is NOT tied to a data value (in contrast to [DataFieldWithAction](#DataFieldWithAction)). Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon -[*Inline*](UI.xml#L1722)|Boolean|Action should be placed close to (or even inside) the visualized term -[*Determining*](UI.xml#L1725)|Boolean|Determines whether the action completes a process step (e.g. approve, reject). -[Action](UI.xml#L1733)|[ActionName](#ActionName)|Name of an Action, Function, ActionImport, or FunctionImport in scope -[InvocationGrouping](UI.xml#L1736)|[OperationGroupingType?](#OperationGroupingType)|Expresses how invocations of this action on multiple instances should be grouped +[*Label*](UI.xml#L1681)|String?|A short, human-readable text suitable for labels and captions in UIs +[*Criticality*](UI.xml#L1685)|[CriticalityType?](#CriticalityType)|Criticality of the data field value +[*CriticalityRepresentation*](UI.xml#L1688)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon +[*IconUrl*](UI.xml#L1691)|URL?|Optional icon +[*Inline*](UI.xml#L1729)|Boolean|Action should be placed close to (or even inside) the visualized term +[*Determining*](UI.xml#L1732)|Boolean|Determines whether the action completes a process step (e.g. approve, reject). +[Action](UI.xml#L1740)|[ActionName](#ActionName)|Name of an Action, Function, ActionImport, or FunctionImport in scope +[InvocationGrouping](UI.xml#L1743)|[OperationGroupingType?](#OperationGroupingType)|Expresses how invocations of this action on multiple instances should be grouped **Applicable Annotation Terms:** @@ -1009,16 +962,16 @@ Property|Type|Description - [FieldControl](Common.md#FieldControl) -## [OperationGroupingType](UI.xml#L1740) +## [OperationGroupingType](UI.xml#L1747) Member|Value|Description :-----|----:|:---------- -[Isolated](UI.xml#L1741)|0|Invoke each action in isolation from other actions -[ChangeSet](UI.xml#L1744)|1|Group all actions into a single change set +[Isolated](UI.xml#L1748)|0|Invoke each action in isolation from other actions +[ChangeSet](UI.xml#L1751)|1|Group all actions into a single change set -## [DataFieldForIntentBasedNavigation](UI.xml#L1749): [DataFieldForActionAbstract](#DataFieldForActionAbstract) +## [DataFieldForIntentBasedNavigation](UI.xml#L1756): [DataFieldForActionAbstract](#DataFieldForActionAbstract) Triggers intent-based UI navigation The navigation intent is expressed as a Semantic Object and optionally an Action on that object. @@ -1027,17 +980,17 @@ It is NOT tied to a data value (in contrast to [DataFieldWithIntentBasedNavigati Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon -[*Inline*](UI.xml#L1722)|Boolean|Action should be placed close to (or even inside) the visualized term -[*Determining*](UI.xml#L1725)|Boolean|Determines whether the action completes a process step (e.g. approve, reject). -[SemanticObject](UI.xml#L1756)|String|Name of the Semantic Object -[Action](UI.xml#L1759)|String?|Name of the Action on the Semantic Object. If not specified, let user choose which of the available actions to trigger. -[NavigationAvailable](UI.xml#L1762)|Boolean|The navigation intent is for that user with the selected context and parameters available -[RequiresContext](UI.xml#L1765)|Boolean|Determines whether a context needs to be passed to the target of this navigation. -[Mapping](UI.xml#L1768)|\[[SemanticObjectMappingType](Common.md#SemanticObjectMappingType)\]|Maps properties of the annotated entity type to properties of the Semantic Object +[*Label*](UI.xml#L1681)|String?|A short, human-readable text suitable for labels and captions in UIs +[*Criticality*](UI.xml#L1685)|[CriticalityType?](#CriticalityType)|Criticality of the data field value +[*CriticalityRepresentation*](UI.xml#L1688)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon +[*IconUrl*](UI.xml#L1691)|URL?|Optional icon +[*Inline*](UI.xml#L1729)|Boolean|Action should be placed close to (or even inside) the visualized term +[*Determining*](UI.xml#L1732)|Boolean|Determines whether the action completes a process step (e.g. approve, reject). +[SemanticObject](UI.xml#L1763)|String|Name of the Semantic Object +[Action](UI.xml#L1766)|String?|Name of the Action on the Semantic Object. If not specified, let user choose which of the available actions to trigger. +[NavigationAvailable](UI.xml#L1769)|Boolean|The navigation intent is for that user with the selected context and parameters available +[RequiresContext](UI.xml#L1772)|Boolean|Determines whether a context needs to be passed to the target of this navigation. +[Mapping](UI.xml#L1775)|\[[SemanticObjectMappingType](Common.md#SemanticObjectMappingType)\]|Maps properties of the annotated entity type to properties of the Semantic Object **Applicable Annotation Terms:** @@ -1049,16 +1002,16 @@ Property|Type|Description - [FieldControl](Common.md#FieldControl) -## [DataFieldForActionGroup](UI.xml#L1773): [DataFieldAbstract](#DataFieldAbstract) *([Experimental](Common.md#Experimental))* +## [DataFieldForActionGroup](UI.xml#L1780): [DataFieldAbstract](#DataFieldAbstract) *([Experimental](Common.md#Experimental))* Collection of OData actions and intent based navigations Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon -[Actions](UI.xml#L1776)|\[[DataFieldForActionAbstract](#DataFieldForActionAbstract)\]|Collection of data fields that refer to actions or intent based navigations +[*Label*](UI.xml#L1681)|String?|A short, human-readable text suitable for labels and captions in UIs +[*Criticality*](UI.xml#L1685)|[CriticalityType?](#CriticalityType)|Criticality of the data field value +[*CriticalityRepresentation*](UI.xml#L1688)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon +[*IconUrl*](UI.xml#L1691)|URL?|Optional icon +[Actions](UI.xml#L1783)|\[[DataFieldForActionAbstract](#DataFieldForActionAbstract)\]|Collection of data fields that refer to actions or intent based navigations **Applicable Annotation Terms:** @@ -1070,7 +1023,7 @@ Property|Type|Description - [FieldControl](Common.md#FieldControl) -## [DataField](UI.xml#L1781): [DataFieldAbstract](#DataFieldAbstract) +## [DataField](UI.xml#L1788): [DataFieldAbstract](#DataFieldAbstract) A piece of data **Derived Types:** @@ -1082,11 +1035,11 @@ A piece of data Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon -[Value](UI.xml#L1783)|Untyped|The data field's value +[*Label*](UI.xml#L1681)|String?|A short, human-readable text suitable for labels and captions in UIs +[*Criticality*](UI.xml#L1685)|[CriticalityType?](#CriticalityType)|Criticality of the data field value +[*CriticalityRepresentation*](UI.xml#L1688)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon +[*IconUrl*](UI.xml#L1691)|URL?|Optional icon +[Value](UI.xml#L1790)|Untyped|The data field's value **Applicable Annotation Terms:** @@ -1098,19 +1051,19 @@ Property|Type|Description - [FieldControl](Common.md#FieldControl) -## [DataFieldWithAction](UI.xml#L1810): [DataField](#DataField) +## [DataFieldWithAction](UI.xml#L1817): [DataField](#DataField) A piece of data that allows triggering an OData action The action is tied to a data value. This is in contrast to [DataFieldForAction](#DataFieldForAction) which is not tied to a specific data value. Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon -[Value](UI.xml#L1813)|PrimitiveType|The data field's value -[Action](UI.xml#L1814)|[ActionName](#ActionName)|Name of an Action, Function, ActionImport, or FunctionImport in scope +[*Label*](UI.xml#L1681)|String?|A short, human-readable text suitable for labels and captions in UIs +[*Criticality*](UI.xml#L1685)|[CriticalityType?](#CriticalityType)|Criticality of the data field value +[*CriticalityRepresentation*](UI.xml#L1688)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon +[*IconUrl*](UI.xml#L1691)|URL?|Optional icon +[Value](UI.xml#L1820)|PrimitiveType|The data field's value +[Action](UI.xml#L1821)|[ActionName](#ActionName)|Name of an Action, Function, ActionImport, or FunctionImport in scope **Applicable Annotation Terms:** @@ -1122,7 +1075,7 @@ Property|Type|Description - [FieldControl](Common.md#FieldControl) -## [DataFieldWithIntentBasedNavigation](UI.xml#L1819): [DataField](#DataField) +## [DataFieldWithIntentBasedNavigation](UI.xml#L1826): [DataField](#DataField) A piece of data that allows triggering intent-based UI navigation The navigation intent is expressed as a Semantic Object and optionally an Action on that object. @@ -1132,14 +1085,14 @@ This is in contrast to [DataFieldForIntentBasedNavigation](#DataFieldForIntentBa Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon -[Value](UI.xml#L1827)|PrimitiveType|The data field's value -[SemanticObject](UI.xml#L1828)|String|Name of the Semantic Object -[Action](UI.xml#L1831)|String?|Name of the Action on the Semantic Object. If not specified, let user choose which of the available actions to trigger. -[Mapping](UI.xml#L1834)|\[[SemanticObjectMappingType](Common.md#SemanticObjectMappingType)\]|Maps properties of the annotated entity type to properties of the Semantic Object +[*Label*](UI.xml#L1681)|String?|A short, human-readable text suitable for labels and captions in UIs +[*Criticality*](UI.xml#L1685)|[CriticalityType?](#CriticalityType)|Criticality of the data field value +[*CriticalityRepresentation*](UI.xml#L1688)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon +[*IconUrl*](UI.xml#L1691)|URL?|Optional icon +[Value](UI.xml#L1834)|PrimitiveType|The data field's value +[SemanticObject](UI.xml#L1835)|String|Name of the Semantic Object +[Action](UI.xml#L1838)|String?|Name of the Action on the Semantic Object. If not specified, let user choose which of the available actions to trigger. +[Mapping](UI.xml#L1841)|\[[SemanticObjectMappingType](Common.md#SemanticObjectMappingType)\]|Maps properties of the annotated entity type to properties of the Semantic Object **Applicable Annotation Terms:** @@ -1151,19 +1104,19 @@ Property|Type|Description - [FieldControl](Common.md#FieldControl) -## [DataFieldWithNavigationPath](UI.xml#L1839): [DataField](#DataField) +## [DataFieldWithNavigationPath](UI.xml#L1846): [DataField](#DataField) A piece of data that allows navigating to related data It should be rendered as a hyperlink Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon -[Value](UI.xml#L1842)|PrimitiveType|The data field's value -[Target](UI.xml#L1843)|NavigationPropertyPath|Contains either a navigation property or a term cast, where term is of type Edm.EntityType or a concrete entity type or a collection of these types +[*Label*](UI.xml#L1681)|String?|A short, human-readable text suitable for labels and captions in UIs +[*Criticality*](UI.xml#L1685)|[CriticalityType?](#CriticalityType)|Criticality of the data field value +[*CriticalityRepresentation*](UI.xml#L1688)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon +[*IconUrl*](UI.xml#L1691)|URL?|Optional icon +[Value](UI.xml#L1849)|PrimitiveType|The data field's value +[Target](UI.xml#L1850)|NavigationPropertyPath|Contains either a navigation property or a term cast, where term is of type Edm.EntityType or a concrete entity type or a collection of these types **Applicable Annotation Terms:** @@ -1175,20 +1128,20 @@ Property|Type|Description - [FieldControl](Common.md#FieldControl) -## [DataFieldWithUrl](UI.xml#L1850): [DataField](#DataField) +## [DataFieldWithUrl](UI.xml#L1857): [DataField](#DataField) A piece of data that allows navigating to other information on the Web It should be rendered as a hyperlink Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon -[Value](UI.xml#L1853)|PrimitiveType|The data field's value -[Url](UI.xml#L1854)|URL|Target of the hyperlink
Can be annotated with: -[UrlContentType](UI.xml#L1863)|MediaType?|Media type of the hyperlink target, e.g. `video/mp4` +[*Label*](UI.xml#L1681)|String?|A short, human-readable text suitable for labels and captions in UIs +[*Criticality*](UI.xml#L1685)|[CriticalityType?](#CriticalityType)|Criticality of the data field value +[*CriticalityRepresentation*](UI.xml#L1688)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon +[*IconUrl*](UI.xml#L1691)|URL?|Optional icon +[Value](UI.xml#L1860)|PrimitiveType|The data field's value +[Url](UI.xml#L1861)|URL|Target of the hyperlink
Can be annotated with: +[UrlContentType](UI.xml#L1870)|MediaType?|Media type of the hyperlink target, e.g. `video/mp4` **Applicable Annotation Terms:** @@ -1200,17 +1153,17 @@ Property|Type|Description - [FieldControl](Common.md#FieldControl) -## [DataFieldWithActionGroup](UI.xml#L1869): [DataField](#DataField) *([Experimental](Common.md#Experimental))* +## [DataFieldWithActionGroup](UI.xml#L1876): [DataField](#DataField) *([Experimental](Common.md#Experimental))* Collection of OData actions and intent based navigations Property|Type|Description :-------|:---|:---------- -[*Label*](UI.xml#L1674)|String?|A short, human-readable text suitable for labels and captions in UIs -[*Criticality*](UI.xml#L1678)|[CriticalityType?](#CriticalityType)|Criticality of the data field value -[*CriticalityRepresentation*](UI.xml#L1681)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon -[*IconUrl*](UI.xml#L1684)|URL?|Optional icon -[Value](UI.xml#L1872)|PrimitiveType|The data field's value -[Actions](UI.xml#L1873)|\[[DataField](#DataField)\]|Collection of data fields that are either [DataFieldWithAction](#DataFieldWithAction), [DataFieldWithIntentBasedNavigation](#DataFieldWithIntentBasedNavigation), [DataFieldWithNavigationPath](#DataFieldWithNavigationPath), or [DataFieldWithUrl](#DataFieldWithUrl) +[*Label*](UI.xml#L1681)|String?|A short, human-readable text suitable for labels and captions in UIs +[*Criticality*](UI.xml#L1685)|[CriticalityType?](#CriticalityType)|Criticality of the data field value +[*CriticalityRepresentation*](UI.xml#L1688)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon +[*IconUrl*](UI.xml#L1691)|URL?|Optional icon +[Value](UI.xml#L1879)|PrimitiveType|The data field's value +[Actions](UI.xml#L1880)|\[[DataField](#DataField)\]|Collection of data fields that are either [DataFieldWithAction](#DataFieldWithAction), [DataFieldWithIntentBasedNavigation](#DataFieldWithIntentBasedNavigation), [DataFieldWithNavigationPath](#DataFieldWithNavigationPath), or [DataFieldWithUrl](#DataFieldWithUrl) **Applicable Annotation Terms:** @@ -1222,7 +1175,7 @@ Property|Type|Description - [FieldControl](Common.md#FieldControl) -## [RecommendationStateType](UI.xml#L1911) +## [RecommendationStateType](UI.xml#L1918) **Type:** Byte Indicates whether a field contains or has a recommended value @@ -1231,44 +1184,44 @@ Editable fields for which a recommendation has been pre-filled or that have reco Allowed Value|Description :------------|:---------- -[0](UI.xml#L1918)|regular - with human or default input, no recommendation -[1](UI.xml#L1922)|highlighted - without human input and with recommendation -[2](UI.xml#L1926)|warning - with human or default input and with recommendation +[0](UI.xml#L1925)|regular - with human or default input, no recommendation +[1](UI.xml#L1929)|highlighted - without human input and with recommendation +[2](UI.xml#L1933)|warning - with human or default input and with recommendation -## [RecommendationListType](UI.xml#L1941) +## [RecommendationListType](UI.xml#L1948) Reference to a recommendation list A recommendation consists of one or more values for editable fields plus a rank between 0.0 and 9.9, with 9.9 being the best recommendation. Property|Type|Description :-------|:---|:---------- -[CollectionPath](UI.xml#L1946)|String|Resource path of a collection of recommended values -[RankProperty](UI.xml#L1949)|String|Name of the property within the collection of recommended values that describes the rank of the recommendation -[Binding](UI.xml#L1952)|\[[RecommendationBinding](#RecommendationBinding)\]|List of pairs of a local property and recommended value property +[CollectionPath](UI.xml#L1953)|String|Resource path of a collection of recommended values +[RankProperty](UI.xml#L1956)|String|Name of the property within the collection of recommended values that describes the rank of the recommendation +[Binding](UI.xml#L1959)|\[[RecommendationBinding](#RecommendationBinding)\]|List of pairs of a local property and recommended value property -## [RecommendationBinding](UI.xml#L1957) +## [RecommendationBinding](UI.xml#L1964) Property|Type|Description :-------|:---|:---------- -[LocalDataProperty](UI.xml#L1958)|PropertyPath|Path to editable property for which recommended values exist -[ValueListProperty](UI.xml#L1961)|String|Path to property in the collection of recommended values. Format is identical to PropertyPath annotations. +[LocalDataProperty](UI.xml#L1965)|PropertyPath|Path to editable property for which recommended values exist +[ValueListProperty](UI.xml#L1968)|String|Path to property in the collection of recommended values. Format is identical to PropertyPath annotations. -## [*PropertyRecommendationType*](UI.xml#L1979) *([Experimental](Common.md#Experimental))* +## [*PropertyRecommendationType*](UI.xml#L1986) *([Experimental](Common.md#Experimental))* Base type containing recommendations for an entity type property Property|Type|Description :-------|:---|:---------- -[RecommendedFieldValue](UI.xml#L1982)|PrimitiveType|Recommended value
In informal specializations of this base type, this property is specialized to the primitive type of the entity type property. If the recommendation has a description, this property has a [`Common.Text`](Common.md#Text) annotation that evaluates to the `RecommendedFieldDescription` property. -[RecommendedFieldDescription](UI.xml#L1991)|String?|Description of the recommended value
In informal specializations of this base type, this property is specialized to the string type of the text property corresponding to the entity type property. It is omitted from informal specializations for recommendations without description. -[RecommendedFieldScoreValue](UI.xml#L1998)|Decimal?|Confidence score of the recommended value -[RecommendedFieldIsSuggestion](UI.xml#L2001)|Boolean|Whether the recommended value shall be suggested in the input field
For any collection of a specialization of `PropertyRecommendationType` in a property containing [`Recommendations`](#Recommendations), this flag can be true in at most one instance of the collection, and only if the `RecommendedFieldScoreValue` exceeds a certain threshold. +[RecommendedFieldValue](UI.xml#L1989)|PrimitiveType|Recommended value
In informal specializations of this base type, this property is specialized to the primitive type of the entity type property. If the recommendation has a description, this property has a [`Common.Text`](Common.md#Text) annotation that evaluates to the `RecommendedFieldDescription` property. +[RecommendedFieldDescription](UI.xml#L1998)|String?|Description of the recommended value
In informal specializations of this base type, this property is specialized to the string type of the text property corresponding to the entity type property. It is omitted from informal specializations for recommendations without description. +[RecommendedFieldScoreValue](UI.xml#L2005)|Decimal?|Confidence score of the recommended value +[RecommendedFieldIsSuggestion](UI.xml#L2008)|Boolean|Whether the recommended value shall be suggested in the input field
For any collection of a specialization of `PropertyRecommendationType` in a property containing [`Recommendations`](#Recommendations), this flag can be true in at most one instance of the collection, and only if the `RecommendedFieldScoreValue` exceeds a certain threshold. -## [ActionName](UI.xml#L2031) +## [ActionName](UI.xml#L2038) **Type:** String Name of an Action, Function, ActionImport, or FunctionImport in scope diff --git a/vocabularies/UI.xml b/vocabularies/UI.xml index 73fd8610..b60e07be 100644 --- a/vocabularies/UI.xml +++ b/vocabularies/UI.xml @@ -715,25 +715,32 @@ The trend is - + + + Each facet must reference one of +- [`FieldGroupDimensions`](#FieldGroupDimensions) +- [`FieldGroupMeasures`](#FieldGroupMeasures) + Exactly one such facet must occur in `Columns` and `Rows` together. +- a [`CollectionFacet`](#CollectionFacet) of `ReferenceFacet`s whose `Target`s are [`Analytics.StructureElement`](Analytics.md#StructureElement)s + At most one such facet may occur in `Columns` and `Rows` together. + - + + + + The same conditions as for `Columns` apply to the facets. + - - + + - - - - - - - + +