{ "title": "JSON schema for SAP.CARD Namespace", "description": "Represents general card attributes", "type": "object", "additionalProperties": false, "required": [ "type", "header" ], "properties": { "_version": { "description": "Represents SAP.CARD attributes format version. It is managed by namespace owner", "type": "string", "enum": [ "1.1.0", "1.2.0", "1.3.0", "1.4.0", "1.5.0", "1.6.0", "1.7.0", "1.8.0", "1.9.0", "1.10.0", "1.11.0", "1.13.0", "1.14.0", "1.15.0", "1.16.0", "1.17.0", "1.18.0", "1.19.0", "1.20.0", "1.21.0", "1.22.0", "1.23.0", "1.24.0", "1.25.0", "1.26.0", "1.27.0", "1.28.0", "1.29.0", "1.30.0", "1.31.0", "1.32.0", "1.33.0", "1.34.0", "1.35.0", "1.36.0", "1.37.0", "1.38.0", "1.39.0", "1.40.0", "1.41.0", "1.42.0", "1.43.0", "1.44.0", "1.45.0", "1.46.0", "1.47.0", "1.48.0", "1.49.0", "1.50.0", "1.51.0", "1.52.0", "1.53.0", "1.54.0", "1.55.0", "1.56.0", "1.57.0", "1.58.0", "1.59.0", "1.60.0", "1.61.0", "1.62.0" ] }, "designtime": { "description": "[Deprecated] The path to the design time folder with assets files", "type": "string", "deprecated": true }, "configuration": { "description": "General configuration of the card. Allows to define parameters, destinations, filters and more", "type": "object", "additionalProperties": false, "properties": { "editor": { "description": "The path to the design time configuration file. Used for Configuration Editor", "type": "string" }, "enableMarkdown": { "description": "Markdown enablement for Adaptive Content", "type": "boolean" }, "helpId": { "description": "[Experimental] The help-id which will be rendered as data-help-id on the base element of the card", "type": "string" }, "modelSizeLimit": { "description": "[Experimental] Represents the maximum number of entries that are used for list bindings", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ], "default": 1000 }, "parameters": { "description": "Map of parameters", "type": "object", "additionalProperties": { "$ref": "#/$defs/Configuration.Parameter" } }, "filters": { "description": "Map of filters", "type": "object", "additionalProperties": { "oneOf": [ { "$ref": "#/$defs/Configuration.FilterType.Select" }, { "$ref": "#/$defs/Configuration.FilterType.DateRange" }, { "$ref": "#/$defs/Configuration.FilterType.Search" }, { "$ref": "#/$defs/Configuration.FilterType.ComboBox" } ] } }, "destinations": { "description": "Specifies the destinations configured for use by the card", "type": "object", "additionalProperties": { "$ref": "#/$defs/Configuration.Destinations" } }, "useMainDestinations": { "description": "Indicates if child cards should reference the main card's destinations. Must be set to true in child cards to use the main card's destinations", "type": "boolean", "default": false }, "csrfTokens": { "description": "Describes the CSRF tokens used by the card", "type": "object", "additionalProperties": { "$ref": "#/$defs/Configuration.CSRFToken" } }, "actionHandlers": { "description": "Contains configuration settings for the default action handlers", "type": "object", "additionalProperties": false, "properties": { "submit": { "description": "Configuration for the submit action handler", "type": "object" } } }, "messages": { "description": "Describes the messages for the card", "type": "object", "additionalProperties": { "$ref": "#/$defs/Configuration.NoData" } }, "componentData": { "description": "[Experimental] Object which will be passed to the component as 'componentData'", "type": "object" }, "loadingPlaceholders": { "description": "[Experimental] Object that will represent the loading placeholder of the card", "type": "object", "properties": { "delay": { "description": "The delay of the loading placeholder", "type": "number" } } }, "childCards": { "description": "[Experimental] Map of child cards", "type": "object", "additionalProperties": { "$ref": "#/$defs/Configuration.ChildCard" } } } }, "customSettings": { "description": "[RESTRICTED] Defines custom settings passed from the Mobile SDK or a hosting application. These are global defaults that can be overridden by individual cards via their manifest. The value is an object containing custom settings as key-value pairs. This property is restricted to Mobile SDK usage", "type": "object" }, "type": { "description": "Represents the type of the card's content", "type": "string", "enum": [ "AdaptiveCard", "Analytical", "AnalyticsCloud", "Calendar", "Component", "List", "Object", "Table", "Timeline", "WebPage" ] }, "data": { "$ref": "#/$defs/data" }, "headerPosition": { "description": "Represents card header position - under or over the content", "type": "string", "oneOf": [ { "enum": [ "Top", "Bottom" ], "default": "Top" }, { "$ref": "#/$defs/simpleBinding" } ] }, "header": { "description": "Represents card header attributes", "$ref": "#/$defs/HeaderType" }, "content": { "description": "Represents card content attributes. Content type should be the same as card type e.g. if card type List is used the content type should also be List" }, "extension": { "description": "A path to an Extension implementation. It is resolved relatively to the manifest", "type": "string" }, "footer": { "description": "Represent card footer attributes", "type": "object", "additionalProperties": false, "properties": { "actionsStrip": { "description": "Describes actions strip", "oneOf": [ { "type": "array", "items": { "$ref": "#/$defs/actionsStripItem" } }, { "$ref": "#/$defs/actionsStrip" } ] }, "paginator": { "description": "[Experimental] Describes the paginator", "type": "object", "additionalProperties": false, "properties": { "pageSize": { "description": "Represents the number of the items in one page", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "totalCount": { "description": "Represents the total count of the items in all pages", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "visible": { "description": "[Experimental] Visibility of the footer", "$ref": "#/$defs/visibility" }, "showSeparator": { "description": "Determines whether to display a separator line at the top of the footer to visually separate the footer from the card content area.", "oneOf": [ { "type": "boolean", "default": false }, { "$ref": "#/$defs/simpleBinding" } ] }, "closeButton": { "description": "[Experimental] Defines the Close button when the card is opened by the ShowCard action", "$ref": "#/$defs/closeButton" } } }, "requiredHeight": { "description": "Represents card minimum required height", "type": "string" }, "requiredWidth": { "description": "Represents card minimum required width", "type": "string" } }, "allOf": [ { "if": { "properties": { "type": { "const": "List" } } }, "then": { "properties": { "content": { "$ref": "#/$defs/ContentType.List" } } } }, { "if": { "properties": { "type": { "const": "Analytical" } } }, "then": { "properties": { "content": { "$ref": "#/$defs/ContentType.Analytical" } } } }, { "if": { "properties": { "type": { "const": "AnalyticsCloud" } } }, "then": { "properties": { "content": { "$ref": "#/$defs/ContentType.AnalyticsCloud" } } } }, { "if": { "properties": { "type": { "const": "Timeline" } } }, "then": { "properties": { "content": { "$ref": "#/$defs/ContentType.Timeline" } } } }, { "if": { "properties": { "type": { "const": "Table" } } }, "then": { "properties": { "content": { "$ref": "#/$defs/ContentType.Table" } } } }, { "if": { "properties": { "type": { "const": "Object" } } }, "then": { "properties": { "content": { "$ref": "#/$defs/ContentType.Object" } } } }, { "if": { "properties": { "type": { "const": "Component" } } }, "then": { "properties": { "content": { "$ref": "#/$defs/ContentType.Component" } } } }, { "if": { "properties": { "type": { "const": "Calendar" } } }, "then": { "properties": { "content": { "$ref": "#/$defs/ContentType.Calendar" } } } }, { "if": { "properties": { "type": { "const": "AdaptiveCard" } } }, "then": { "properties": { "content": { "$ref": "#/$defs/ContentType.AdaptiveCard" } } } }, { "if": { "properties": { "type": { "const": "WebPage" } } }, "then": { "properties": { "content": { "$ref": "#/$defs/ContentType.WebPage" } } } } ], "$defs": { "HeaderType": { "oneOf": [ { "$ref": "#/$defs/HeaderType.Default" }, { "$ref": "#/$defs/HeaderType.Numeric" } ] }, "HeaderType.Default": { "additionalProperties": false, "description": "Represents default header attributes", "type": "object", "properties": { "type": { "description": "Represents the type of the header", "type": "string", "enum": [ "Default" ] }, "title": { "description": "Represents a title of the header; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'", "$ref": "#/$defs/i18n_key_string", "i18n": { "type": "XTIT", "comment": "Header title" } }, "titleMaxLines": { "description": "[Experimental] Limit the number of lines for the title", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ], "default": 3 }, "subTitle": { "description": "[Deprecated] Represents a subtitle to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'", "$ref": "#/$defs/i18n_key_string", "deprecated": true, "i18n": { "type": "XTIT", "comment": "Header subtitle" } }, "subtitle": { "description": "Represents a subtitle to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'", "$ref": "#/$defs/i18n_key_string", "i18n": { "type": "XTIT", "comment": "Header subtitle" } }, "subTitleMaxLines": { "description": "[Deprecated] Limit the number of lines for the sub title", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ], "deprecated": true, "default": 2 }, "subtitleMaxLines": { "description": "[Experimental] Limit the number of lines for the sub title", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ], "default": 2 }, "actions": { "description": "Represents a description of the actions that can be applied on a part of a card", "type": "array", "items": { "$ref": "#/$defs/action" } }, "data": { "$ref": "#/$defs/data" }, "icon": { "description": "Represents the icon of the card", "$ref": "#/$defs/iconWithoutSize" }, "status": { "description": "Represents the status of the card", "$ref": "#/$defs/status" }, "closeButton": { "description": "[Experimental] Represents the Close button when a card is opened by the ShowCard action", "$ref": "#/$defs/closeButton", "deprecated": true }, "wrappingType": { "description": "[Experimental] The wrapping type for texts inside the header", "$ref": "#/$defs/wrappingType" }, "visible": { "description": "[Experimental] Visibility of the header", "$ref": "#/$defs/visibility" }, "infoSection": { "description": "[Experimental] Represents the info section of the header", "$ref": "#/$defs/HeaderType.InfoSection" } } }, "HeaderType.Numeric": { "additionalProperties": false, "required": [ "type" ], "description": "Represents header with numeric data", "type": "object", "properties": { "type": { "description": "Represents the type of the header", "type": "string", "enum": [ "Numeric" ] }, "title": { "description": "Represents a title of the header; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'", "$ref": "#/$defs/i18n_key_string", "i18n": { "type": "XTIT", "comment": "Header title" } }, "titleMaxLines": { "description": "[Experimental] Limit the number of lines for the title", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ], "default": 3 }, "subtitle": { "description": "Represents a subtitle to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'", "$ref": "#/$defs/i18n_key_string", "i18n": { "type": "XTIT", "comment": "Header subtitle" } }, "subTitle": { "description": "[Deprecated] Represents a subtitle to the title; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'", "$ref": "#/$defs/i18n_key_string", "i18n": { "type": "XTIT", "comment": "Header subtitle" }, "deprecated": true }, "subtitleMaxLines": { "description": "[Experimental] Limit the number of lines for the sub title", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ], "default": 2 }, "subTitleMaxLines": { "description": "[Deprecated] Limit the number of lines for the sub title", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ], "deprecated": true, "default": 2 }, "actions": { "description": "Represents a description of the actions that can be applied on a part of a card", "type": "array", "items": { "$ref": "#/$defs/action" } }, "data": { "$ref": "#/$defs/data" }, "unitOfMeasurement": { "description": "Represents unit of measurement for the whole numeric header", "type": "string" }, "mainIndicator": { "$ref": "#/$defs/HeaderType.Numeric.MainIndicator" }, "sideIndicatorsAlignment": { "description": "The alignment of the side indicators", "type": "string", "oneOf": [ { "enum": [ "Begin", "End" ], "default": "Begin" }, { "$ref": "#/$defs/simpleBinding" } ] }, "details": { "description": "Represents additional information about the numeric header", "type": "string" }, "detailsMaxLines": { "description": "[Experimental] Limit the number of lines for the details text", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ], "default": 1 }, "sideIndicators": { "description": "Multiple side indicators that relate to the main numeric indicator", "type": "array", "maxItems": 2, "items": { "$ref": "#/$defs/HeaderType.Numeric.SideIndicator" } }, "status": { "description": "Represents the status of the card", "$ref": "#/$defs/status" }, "closeButton": { "description": "[Experimental] Represents the Close button when a card is opened by the ShowCard action", "$ref": "#/$defs/closeButton", "deprecated": true }, "wrappingType": { "description": "[Experimental] The wrapping type for texts inside the header", "$ref": "#/$defs/wrappingType" }, "visible": { "description": "[Experimental] Visibility of the header", "$ref": "#/$defs/visibility" }, "infoSection": { "description": "[Experimental] Represents the info section of the header", "$ref": "#/$defs/HeaderType.InfoSection" }, "chart": { "$ref": "#/$defs/MicroChart" } } }, "HeaderType.Numeric.MainIndicator": { "description": "Represents the main numeric indicator of the header", "type": "object", "additionalProperties": false, "properties": { "number": { "description": "The value of the main indicator", "type": "string" }, "unit": { "description": "The unit of the main indicator", "type": "string" }, "trend": { "description": "The trend indicator (direction)", "type": "string", "oneOf": [ { "enum": [ "Down", "None", "Up" ], "default": "None" }, { "$ref": "#/$defs/simpleBinding" } ] }, "state": { "description": "The state color of the main indicator", "type": "string", "oneOf": [ { "description": "The state color of the main indicator", "$ref": "#/$defs/Enums.ValueColor" }, { "$ref": "#/$defs/simpleBinding" } ] }, "visible": { "description": "Visibility of the main indicator", "$ref": "#/$defs/visibility" } } }, "HeaderType.Numeric.SideIndicator": { "description": "Represents side indicator attributes which are used for additional information about the main indicator", "type": "object", "additionalProperties": false, "properties": { "title": { "description": "Represents a title of the side indicator", "type": "string" }, "number": { "description": "Represents value of the side indicator", "type": "string" }, "unit": { "description": "Represents unit of measurement of the side indicator", "type": "string" }, "state": { "description": "The state color of the side indicator", "type": "string", "oneOf": [ { "description": "The state color of the side indicator", "$ref": "#/$defs/Enums.ValueColor" }, { "$ref": "#/$defs/simpleBinding" } ] }, "visible": { "description": "Visibility of the side indicator", "$ref": "#/$defs/visibility" } } }, "HeaderType.InfoSection": { "description": "Represents the info section of the header", "type": "object", "additionalProperties": false, "properties": { "rows": { "description": "Represents the rows of the info section", "type": "array", "items": { "$ref": "#/$defs/HeaderType.InfoSection.Row" } } } }, "HeaderType.InfoSection.Item": { "description": "Represents an info section item", "oneOf": [ { "$ref": "#/$defs/objectStatus" } ] }, "HeaderType.InfoSection.Row": { "description": "Represents a row of the info section", "type": "object", "additionalProperties": false, "properties": { "justifyContent": { "$ref": "#/$defs/justifyContent" }, "columns": { "description": "Represents the columns of the row", "type": "array", "items": { "$ref": "#/$defs/HeaderType.InfoSection.Column" } }, "items": { "description": "Represents the items of the row", "type": "array", "items": { "$ref": "#/$defs/HeaderType.InfoSection.Item" } } } }, "HeaderType.InfoSection.Column": { "description": "Represents a column of the info section", "type": "object", "additionalProperties": false, "properties": { "rows": { "description": "Represents the rows of the column", "type": "array", "items": { "$ref": "#/$defs/HeaderType.InfoSection.Row" } }, "items": { "description": "Represents the items of the column", "type": "array", "items": { "$ref": "#/$defs/HeaderType.InfoSection.Item" } } } }, "ContentType.Component": { "description": "Represents the configuration for a component card's content", "type": "object", "additionalProperties": false, "properties": { "minHeight": { "$ref": "#/$defs/minHeight" } } }, "ContentType.List": { "description": "Represents list content attributes", "type": "object", "additionalProperties": false, "properties": { "data": { "$ref": "#/$defs/data" }, "item": { "$ref": "#/$defs/ContentType.List.Item" }, "maxItems": { "description": "Represents number of items", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "minItems": { "description": "Represents the minimum expected number of items", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "group": { "$ref": "#/$defs/group" } } }, "ContentType.List.Item": { "description": "The template for all items", "type": "object", "additionalProperties": false, "properties": { "title": { "description": "The title of the item", "oneOf": [ { "$ref": "#/$defs/field" }, { "type": "string" } ] }, "description": { "description": "The description of the item", "oneOf": [ { "$ref": "#/$defs/field" }, { "type": "string" } ] }, "info": { "description": "Defines an additional information text", "$ref": "#/$defs/objectStatus" }, "highlight": { "type": "string", "description": "The highlight state of the item", "oneOf": [ { "$ref": "#/$defs/state" }, { "$ref": "#/$defs/simpleBinding" } ] }, "highlightText": { "type": "string", "description": "Defines the semantics of the 'highlight' property. It is used for accessibility purposes" }, "icon": { "$ref": "#/$defs/icon" }, "attributesLayoutType": { "description": "Defines the layout type of the attributes", "oneOf": [ { "enum": [ "OneColumn", "TwoColumns" ], "default": "TwoColumns" }, { "$ref": "#/$defs/simpleBinding" } ] }, "attributes": { "description": "Defines the attributes", "type": "array", "items": { "$ref": "#/$defs/objectStatus" } }, "actions": { "description": "Defines actions that can be applied on the item", "type": "array", "items": { "$ref": "#/$defs/action" } }, "chart": { "$ref": "#/$defs/MicroChart" }, "actionsStrip": { "description": "Describes actions strip", "oneOf": [ { "type": "array", "items": { "$ref": "#/$defs/actionsStripItem" } }, { "$ref": "#/$defs/actionsStrip" } ] } } }, "ContentType.Analytical": { "description": "Represents analytical content attributes", "type": "object", "additionalProperties": false, "properties": { "data": { "$ref": "#/$defs/data" }, "chartType": { "description": "The type of the chart", "type": "string", "oneOf": [ { "type": "string" }, { "$ref": "#/$defs/simpleBinding" } ] }, "chartProperties": { "description": "[Experimental] Chart configuration", "oneOf": [ { "type": "object" }, { "$ref": "#/$defs/simpleBinding" } ] }, "minHeight": { "$ref": "#/$defs/minHeight" }, "legend": { "$ref": "#/$defs/ContentType.Analytical.Legend" }, "plotArea": { "description": "[Deprecated] Describes the plotArea properties", "type": "object", "additionalProperties": false, "properties": { "dataLabel": { "$ref": "#/$defs/ContentType.Analytical.DataLabel" }, "categoryAxisText": { "$ref": "#/$defs/ContentType.Analytical.AxisText" }, "valueAxisText": { "$ref": "#/$defs/ContentType.Analytical.AxisText" } }, "deprecated": true }, "title": { "description": "[Deprecated] Represents title attributes", "deprecated": true, "type": "object", "additionalProperties": false, "properties": { "visible": { "description": "Represents the visibility state of the title", "$ref": "#/$defs/visibility" }, "text": { "description": "Represents a title text", "type": "string" }, "alignment": { "description": "Represents the title alignment", "oneOf": [ { "enum": [ "Left", "Center", "Right" ], "default": "Center" }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "measureAxis": { "description": "[Deprecated] Represents the value set for measure axis", "deprecated": true, "type": "string" }, "dimensionAxis": { "description": "[Deprecated] Represents the value set for dimension axis", "deprecated": true, "type": "string" }, "dimensions": { "type": "array", "items": { "$ref": "#/$defs/ContentType.Analytical.Dimension" } }, "measures": { "type": "array", "items": { "$ref": "#/$defs/ContentType.Analytical.Measure" } }, "feeds": { "description": "Feeds for the chart", "type": "array", "items": { "$ref": "#/$defs/ContentType.Analytical.Field" } }, "actions": { "description": "Defines actions that can be applied on the content", "type": "array", "items": { "$ref": "#/$defs/action" } }, "actionableArea": { "oneOf": [ { "enum": [ "Full", "Chart" ], "default": "Full" }, { "$ref": "#/$defs/simpleBinding" } ] }, "popover": { "type": "object", "additionalProperties": false, "description": "Configuration for a popover, which will open while pressing chart points", "properties": { "active": { "description": "Whether the popover is connected to the chart. If it's not it won't open", "oneOf": [ { "type": "boolean", "default": false }, { "$ref": "#/$defs/simpleBinding" } ] }, "actionsStrip": { "description": "Defines actions items that can be triggered when the action button is pressed", "type": "array", "maxItems": 1, "items": { "type": "object", "additionalProperties": false, "properties": { "actions": { "description": "Defines actions that will be triggered when the action button is pressed", "type": "array", "items": { "$ref": "#/$defs/action" } }, "text": { "type": "string", "description": "The action button text" } } } } } }, "tooltips": { "description": "Visualize the tooltips that are generated by Viz charts.", "oneOf": [ { "type": "boolean", "default": false }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "ContentType.Analytical.DataLabel": { "description": "Represents value attributes in the plot area", "type": "object", "additionalProperties": false, "properties": { "visible": { "description": "Visibility of the data labels", "$ref": "#/$defs/visibility" }, "showTotal": { "description": "Visibility of data label for total value in some charts", "$ref": "#/$defs/visibility" } } }, "ContentType.Analytical.AxisText": { "description": "Represents descriptive text of the axis", "type": "object", "additionalProperties": false, "properties": { "visible": { "description": "Represents the visibility state of the descriptive axis text", "$ref": "#/$defs/visibility" } } }, "ContentType.Analytical.Legend": { "description": "[Deprecated] Represents chart legend attributes", "deprecated": true, "type": "object", "additionalProperties": false, "properties": { "visible": { "description": "Defines whether the legend will be visible", "$ref": "#/$defs/visibility" }, "position": { "description": "Defines where the legend will be positioned", "type": "string", "oneOf": [ { "enum": [ "Top", "Bottom", "Left", "Right" ], "default": "Right" }, { "$ref": "#/$defs/simpleBinding" } ] }, "alignment": { "description": "Defines how the legend will be aligned", "type": "string", "oneOf": [ { "enum": [ "TopLeft", "Center" ], "default": "TopLeft" }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "ContentType.Analytical.Field": { "type": "object", "additionalProperties": false, "properties": { "type": { "description": "The type of the feed", "oneOf": [ { "enum": [ "Measure", "Dimension" ] }, { "$ref": "#/$defs/simpleBinding" } ] }, "uid": { "description": "The uid of the feed", "type": "string" }, "values": { "description": "The names of the measures or dimensions that are used for this feed", "type": "array", "items": { "type": "string" } } } }, "ContentType.Analytical.Measure": { "description": "Measure for the dataset", "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The name of the measure", "type": "string" }, "label": { "description": "[Deprecated] Label for the measure", "deprecated": true, "type": "string" }, "value": { "type": "string", "description": "Binding path to the data" } } }, "ContentType.Analytical.Dimension": { "description": "Dimension for the dataset", "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The name of the dimension", "type": "string" }, "label": { "description": "[Deprecated] Label for the dimension", "deprecated": true, "type": "string" }, "value": { "type": "string", "description": "Binding path to the data" }, "displayValue": { "type": "string", "description": "Display value for the dimension. It doesn't work with 'waterfallType'" }, "dataType": { "type": "string", "description": "Data type of the dimension as displayed in the chart. Currently only in time series chart, it is required to set data type to 'date' if this column is going to feed the 'timeAxis'", "oneOf": [ { "enum": [ "string", "number", "date" ], "default": "string" }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "ContentType.AnalyticsCloud": { "description": "Represents SAP Analytics Cloud content attributes", "type": "object", "additionalProperties": true }, "ContentType.Timeline": { "description": "Represents time related content", "type": "object", "additionalProperties": false, "properties": { "data": { "$ref": "#/$defs/data" }, "item": { "description": "Defines the timeline item", "$ref": "#/$defs/ContentType.Timeline.Item" }, "maxItems": { "description": "Represents number of items", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "minItems": { "description": "Represents the minimum expected number of items", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "ContentType.Timeline.Item": { "description": "Represents a single timeline item", "type": "object", "additionalProperties": false, "properties": { "title": { "description": "The title of the timeline item", "$ref": "#/$defs/field" }, "description": { "description": "The description of the timeline item", "$ref": "#/$defs/field" }, "dateTime": { "description": "The dateTime value of the timeline item", "$ref": "#/$defs/field" }, "owner": { "description": "The owner of the timeline item", "$ref": "#/$defs/field" }, "ownerImage": { "description": "The owner image of the timeline item", "properties": { "value": { "type": "string" } } }, "icon": { "description": "The icon of the timeline item", "$ref": "#/$defs/simpleIcon" }, "actions": { "description": "Defines actions that can be applied on the item level", "type": "array", "items": { "$ref": "#/$defs/action" } } } }, "ContentType.Object": { "description": "Represents object content attributes", "type": "object", "additionalProperties": false, "properties": { "data": { "$ref": "#/$defs/data" }, "groups": { "description": "Represents groups of information for an object", "type": "array", "items": { "$ref": "#/$defs/ContentType.Object.Group" } }, "actions": { "description": "[Deprecated] Defines actions that can be applied on the content", "type": "array", "deprecated": true, "items": { "$ref": "#/$defs/action" } }, "hasData": { "description": "Represents flag for no data", "oneOf": [ { "type": "boolean" }, { "type": "object" }, { "type": "array" }, { "$ref": "#/$defs/simpleBinding" } ], "default": true } } }, "ContentType.Object.Group": { "description": "Represents a group of information for an object", "type": "object", "required": [ "items" ], "additionalProperties": false, "properties": { "title": { "description": "Represents a title of the object group; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'", "$ref": "#/$defs/i18n_key_string", "i18n": { "type": "XGRP", "comment": "Object group title" } }, "titleMaxLines": { "description": "[Experimental] Limits the number of lines for wrapping the group title", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ], "default": 1 }, "labelWrapping": { "description": "[Experimental] Determines whether the labels of the group items will be wrapped", "oneOf": [ { "type": "boolean" }, { "$ref": "#/$defs/simpleBinding" } ], "default": false }, "items": { "description": "Represents items of information", "type": "array", "items": { "$ref": "#/$defs/ContentType.Object.Item" } }, "visible": { "description": "Represents the visibility state of the group", "$ref": "#/$defs/visibility" }, "alignment": { "description": "[Experimental] Alignment of the group", "enum": [ "Default", "Stretch" ], "default": "Default" } } }, "ContentType.Object.Item": { "description": "Represents a single item of information. It can contain label, value and image", "type": "object", "additionalProperties": false, "properties": { "icon": { "description": "Defines the icon of the item", "$ref": "#/$defs/icon" }, "label": { "description": "Defines the label of the item", "type": "string" }, "showColon": { "description": "Defines whether the colon next to the label is shown", "oneOf": [ { "type": "boolean" }, { "$ref": "#/$defs/simpleBinding" } ] }, "value": { "description": "Represents the text, which is associated with the label", "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "object", "additionalProperties": false, "properties": { "option": { "description": "The date range option", "type": "string" }, "values": { "type": "array" } } } ] }, "tooltip": { "description": "Defines the tooltip of the link", "type": "string" }, "type": { "description": "Defines the type of the displayed information. Some of the types are deprecated", "type": "string", "oneOf": [ { "enum": [ "Default", "NumericData", "Status", "IconGroup", "ComboBox", "TextArea", "Input", "Duration", "DateRange", "RatingIndicator", "RadioButtonGroup", "phone", "email", "link", "text", "Image" ], "default": "Default" }, { "$ref": "#/$defs/simpleBinding" } ] }, "url": { "description": "[Deprecated] Defines the URL string. Works only with items of type 'link'", "deprecated": true, "type": "string" }, "target": { "description": "[Deprecated] Specifies the target of the link - it works like the target property of the HTML 'a' tag. Works only with items of type 'link'", "deprecated": true, "oneOf": [ { "$ref": "#/$defs/target" }, { "$ref": "#/$defs/simpleBinding" } ] }, "emailSubject": { "description": "[Deprecated] Represents the subject of the email. Works only with item of type 'email'", "deprecated": true, "type": "string" }, "actions": { "description": "Defines actions that can be applied on the group item", "type": "array", "items": { "$ref": "#/$defs/action" } }, "visible": { "description": "Represents the visibility state of the item", "$ref": "#/$defs/visibility" }, "mainIndicator": { "description": "[Experimental]", "$ref": "#/$defs/ContentType.Object.Item.MainIndicator" }, "sideIndicators": { "description": "[Experimental] Multiple side indicators that relate to the main numeric indicator", "type": "array", "maxItems": 2, "items": { "$ref": "#/$defs/HeaderType.Numeric.SideIndicator" } }, "sideIndicatorsAlignment": { "description": "[Experimental] The alignment of the side indicators", "type": "string", "oneOf": [ { "enum": [ "Begin", "End" ], "default": "Begin" }, { "$ref": "#/$defs/simpleBinding" } ] }, "template": { "description": "[Experimental] Template definition for the icons in the group", "$ref": "#/$defs/ContentType.Object.Item.IconGroupTemplate" }, "path": { "description": "[Experimental] Binding path to the icon data", "type": "string" }, "size": { "description": "[Experimental] The size of the icons in an IconGroup", "oneOf": [ { "enum": [ "XS", "S", "M" ], "default": "XS" }, { "$ref": "#/$defs/simpleBinding" } ] }, "maxLines": { "description": "Maximum number of lines", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "details": { "description": "Represents additional information about the numeric indicators", "type": "string" }, "state": { "description": "The state color of the item", "$ref": "#/$defs/state" }, "showStateIcon": { "description": "Defines if a default state icon is shown", "oneOf": [ { "type": "boolean" }, { "$ref": "#/$defs/simpleBinding" } ] }, "customStateIcon": { "description": "The custom state icon", "type": "string" }, "inverted": { "description": "Specifies whether the background color reflects the set \"state\" instead of the control's text", "oneOf": [ { "type": "boolean" }, { "$ref": "#/$defs/simpleBinding" } ] }, "id": { "description": "ID for input fields", "type": "string" }, "selectedKey": { "description": "Defines the initially selected key from the given options for combo box or radio button group", "type": "string" }, "selectedIndex": { "description": "Defines the initially selected index for radio button group", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "placeholder": { "description": "Placeholder for items of type 'Input', 'TextArea', 'ComboBox', 'Duration' and 'DateRange'", "type": "string" }, "rows": { "description": "Property rows for TextArea", "type": "number" }, "item": { "type": "object", "description": "Binding info for combo box or radio button group items", "required": [ "template" ], "additionalProperties": false, "properties": { "template": { "oneOf": [ { "$ref": "#/$defs/ContentType.Object.Item.ComboBoxItemTemplate" }, { "$ref": "#/$defs/ContentType.Object.Item.RadioButtonItemTemplate" } ] }, "path": { "description": "Defines the path to the structure holding the data about the items", "type": "string", "default": "/", "pattern": "^[a-zA-Z0-9_\\.\\-/|@#]*$" } } }, "validations": { "type": "array", "items": { "$ref": "#/$defs/ContentType.Object.Item.Validation" } }, "maxValue": { "description": "The number of displayed symbols for RatingIndicator", "oneOf": [ { "type": "number", "default": 5 }, { "$ref": "#/$defs/simpleBinding" } ] }, "visualMode": { "description": "Defines how float values are visualized for RatingIndicator: Full (values are rounded to the nearest integer value (e.g. 1.7 -> 2)) or Half (values are rounded to the nearest half value (e.g. 1.7 -> 1.5))", "oneOf": [ { "enum": [ "Full", "Half" ], "default": "Half" }, { "$ref": "#/$defs/simpleBinding" } ] }, "src": { "type": "string", "description": "Represents image source URL" }, "fallbackSrc": { "type": "string", "description": "Represents fallback image source URL" }, "alt": { "type": "string", "description": "The alternative text that is displayed in case the image is not available, or cannot be displayed" }, "fullWidth": { "description": "Defines if the image will take the full width of the group, including the paddings. If set to false there will be padding. For best result use together with 'alignment': 'Stretched' for the group", "oneOf": [ { "type": "boolean", "default": false }, { "$ref": "#/$defs/simpleBinding" } ] }, "height": { "description": "The height of the image", "type": "string" }, "imageFit": { "description": "This property is for adjusting the image size using the CSS style background-size", "type": "string" }, "imagePosition": { "description": "This property is for adjusting the image position using the CSS style background-position", "type": "string" }, "overlay": { "description": "Overlay on the Image", "type": "object", "properties": { "supertitle": { "description": "The text before the title", "type": "string" }, "title": { "description": "The title", "type": "string" }, "subtitle": { "description": "The subtitle", "type": "string" }, "subTitle": { "description": "The subtitle", "type": "string", "deprecated": true }, "verticalPosition": { "description": "The vertical alignment of the texts", "type": "string" }, "horizontalPosition": { "description": "The horizontal alignment of the texts", "type": "string" }, "padding": { "description": "Set to 'MediumStart' to have medium size padding in the beginning of the texts", "type": "string" }, "textColor": { "description": "The color of the texts", "type": "string" }, "textFilter": { "description": "The CSS filter which will be applied to the text", "type": "string" }, "background": { "description": "The background behind the texts and over the image", "type": "string" }, "animation": { "description": "Defines the animation that should be used to show up the overlay", "type": "string" } } } } }, "ContentType.Object.Item.MainIndicator": { "description": "Represents the main numeric indicator of the NumericData", "type": "object", "additionalProperties": false, "properties": { "number": { "description": "The value of the main indicator", "type": "string" }, "unit": { "description": "The unit of the main indicator", "type": "string" }, "trend": { "description": "The trend indicator (direction)", "type": "string", "oneOf": [ { "enum": [ "Down", "None", "Up" ], "default": "None" }, { "$ref": "#/$defs/simpleBinding" } ] }, "state": { "description": "The state color of the main indicator", "type": "string", "oneOf": [ { "description": "The state color of the main indicator", "$ref": "#/$defs/Enums.ValueColor" }, { "$ref": "#/$defs/simpleBinding" } ] }, "size": { "oneOf": [ { "enum": [ "S", "L" ], "default": "Default" }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "ContentType.Object.Item.IconGroupTemplate": { "description": "Template definition for the icons in the group", "type": "object", "additionalProperties": false, "required": [ "icon" ], "properties": { "icon": { "$ref": "#/$defs/ContentType.Object.Item.IconGroupIcon" }, "actions": { "description": "Defines actions that can be applied on the icon", "type": "array", "items": { "$ref": "#/$defs/action" } } } }, "ContentType.Object.Item.IconGroupIcon": { "description": "Definition for icons in the IconGroup", "type": "object", "additionalProperties": false, "properties": { "src": { "type": "string", "description": "Represents icon name or source URL" }, "text": { "type": "string", "description": "[Deprecated] Represents text that will be displayed in the icon", "deprecated": true }, "initials": { "type": "string", "description": "Used as fallback if the 'src' property is not set or there is an issue with the resource. Up to two Latin letters can be displayed" }, "alt": { "type": "string", "description": "Represents text that will be displayed as a tooltip" } } }, "ContentType.Object.Item.ComboBoxItemTemplate": { "description": "Template for combo box items", "type": "object", "additionalProperties": false, "properties": { "title": { "description": "The title of the option", "type": "string" }, "key": { "description": "The unique key of the option. Mapped to the input's value", "type": "string" } } }, "ContentType.Object.Item.RadioButtonItemTemplate": { "description": "Template for radio button group items", "type": "object", "additionalProperties": false, "required": [ "enabled" ], "properties": { "title": { "description": "The title of the radio button option", "type": "string" }, "key": { "description": "The unique key of the radio button option", "type": "string" }, "enabled": { "description": "Whether the radio button option is enabled", "oneOf": [ { "type": "boolean", "default": true }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "ContentType.Object.Item.Validation": { "description": "[Experimental] Defines the user input validation", "type": "object", "additionalProperties": false, "properties": { "message": { "description": "Defines custom validation message text", "type": "string" }, "type": { "description": "Defines the validation type", "oneOf": [ { "enum": [ "Error", "Warning", "Information" ], "default": "Error" }, { "$ref": "#/$defs/simpleBinding" } ] }, "required": { "description": "Defines whether the user input is required", "oneOf": [ { "type": "boolean", "default": false }, { "$ref": "#/$defs/simpleBinding" } ] }, "minLength": { "description": "Defines the minimum number of characters", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "maxLength": { "description": "Defines the maximum number of characters", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "restrictToPredefinedOptions": { "description": "Defines whether the value is restricted to predefined options", "oneOf": [ { "type": "boolean", "default": false }, { "$ref": "#/$defs/simpleBinding" } ] }, "pattern": { "description": "Sets the regular expression pattern that should match the value", "type": "string" }, "validate": { "description": "An extension function used to validate the value", "type": "string" } } }, "ContentType.Table": { "description": "Represents table content attributes", "type": "object", "additionalProperties": false, "properties": { "data": { "$ref": "#/$defs/data" }, "row": { "description": "The template for all rows", "type": "object", "additionalProperties": false, "properties": { "columns": { "description": "Defines the columns attributes", "type": "array", "items": { "$ref": "#/$defs/ContentType.Table.Column" } }, "actions": { "description": "Defines actions that can be applied on the item", "type": "array", "items": { "$ref": "#/$defs/action" } }, "highlight": { "type": "string", "description": "The highlight state of the row", "oneOf": [ { "$ref": "#/$defs/state" }, { "$ref": "#/$defs/simpleBinding" } ] }, "highlightText": { "type": "string", "description": "Defines the semantics of the 'highlight' property. It is used for accessibility purposes" } } }, "autoPopinMode": { "description": "Controls the table's auto pop-in mode. When true, columns automatically adjust based on available space. When false, manually set 'autoPopinWidth' for each column.", "oneOf": [ { "type": "boolean", "default": false }, { "$ref": "#/$defs/simpleBinding" } ] }, "hiddenInPopin": { "description": "Specifies columns to hide rather than move into the pop-in area, based on importance.", "type": "array", "items": { "type": "string", "enum": [ "None", "Low", "Medium", "High" ] } }, "popinLayout": { "description": "Sets the layout style for rendering table pop-in rows.", "oneOf": [ { "type": "string", "enum": [ "Block", "GridSmall", "GridLarge" ], "default": "Block" }, { "$ref": "#/$defs/simpleBinding" } ] }, "maxItems": { "description": "Represents number of items", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "minItems": { "description": "Represents the minimum expected number of items", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "group": { "$ref": "#/$defs/group" } } }, "ContentType.Table.Column": { "description": "Represents object item attributes", "type": "object", "additionalProperties": false, "properties": { "title": { "description": "Represents a title of the column; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'", "$ref": "#/$defs/i18n_key_string", "i18n": { "type": "XCOL", "comment": "Column title" } }, "width": { "description": "Defines the width of the column", "type": "string" }, "hAlign": { "description": "Defines the horizontal alignment of the column content", "oneOf": [ { "$ref": "#/$defs/textAlign" }, { "$ref": "#/$defs/simpleBinding" } ] }, "value": { "description": "Represents the text value of the column", "type": "string" }, "additionalText": { "description": "Represents the additional text for the identifier column", "type": "string" }, "icon": { "description": "Represents column with icon", "$ref": "#/$defs/icon" }, "state": { "description": "Defines the state of the column", "oneOf": [ { "$ref": "#/$defs/state" }, { "$ref": "#/$defs/simpleBinding" } ] }, "inverted": { "description": "Specifies whether the background color reflects the set \"state\" instead of the control's text", "oneOf": [ { "type": "boolean" }, { "$ref": "#/$defs/simpleBinding" } ] }, "url": { "description": "[Deprecated] Defines the URL string", "deprecated": true, "type": "string" }, "target": { "description": "[Deprecated] Specifies where to open the 'url', if it is provided", "deprecated": true, "type": "string", "oneOf": [ { "$ref": "#/$defs/target" }, { "$ref": "#/$defs/simpleBinding" } ] }, "identifier": { "oneOf": [ { "$ref": "#/$defs/identifier" }, { "$ref": "#/$defs/simpleBinding" } ] }, "progressIndicator": { "description": "Represents progress indicator attributes", "$ref": "#/$defs/progressIndicator" }, "visible": { "description": "Represents the visibility state of the column", "$ref": "#/$defs/visibility" }, "actions": { "description": "Defines actions that can be applied on the group item", "type": "array", "items": { "$ref": "#/$defs/action" } }, "showStateIcon": { "description": "Defines if a default state icon is shown", "oneOf": [ { "type": "boolean" }, { "$ref": "#/$defs/simpleBinding" } ] }, "customStateIcon": { "description": "The custom state icon", "type": "string" }, "importance": { "description": "Specifies the column's significance, affecting its behavior in responsive design.", "oneOf": [ { "enum": [ "None", "Low", "Medium", "High" ], "default": "None" }, { "$ref": "#/$defs/simpleBinding" } ] }, "autoPopinWidth": { "description": "Sets the minimum width threshold for displaying the column in the pop-in area.", "type": "number" } } }, "ContentType.Calendar": { "description": "The calendar card is used to display a schedule of a single entity (such as person, resource) for a selected time interval", "type": "object", "additionalProperties": false, "properties": { "data": { "$ref": "#/$defs/data" }, "item": { "$ref": "#/$defs/ContentType.Calendar.Item" }, "legendItem": { "$ref": "#/$defs/ContentType.Calendar.LegendItem" }, "specialDate": { "$ref": "#/$defs/ContentType.Calendar.SpecialDate" }, "date": { "description": "The initial date of the calendar which appointments are initially shown. The accepted date format is ISO 8601", "oneOf": [ { "type": "string" }, { "$ref": "#/$defs/simpleBinding" } ] }, "maxItems": { "description": "Represents number of items displayed", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "maxLegendItems": { "description": "Represents number of legendItems displayed", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "noItemsText": { "description": "The text shown when there are no items for the selected day", "oneOf": [ { "type": "string" }, { "$ref": "#/$defs/simpleBinding" } ] }, "use12HourFormat": { "description": "Displays the time for calendar appointments in either 12h or 24h formats. By default, time is displayed in 24h format", "oneOf": [ { "type": "boolean" }, { "$ref": "#/$defs/simpleBinding" } ] }, "calendarWeekNumbering": { "description": "Set the first day of week based on one of the available options Default, ISO_8601, MiddleEastern, or WesternTraditional", "oneOf": [ { "enum": [ "Default", "ISO_8601", "MiddleEastern", "WesternTraditional" ], "default": "Default" }, { "$ref": "#/$defs/simpleBinding" } ] }, "moreItems": { "description": "Defines actions that can be applied on the button showing there are more items than the shown", "type": "object", "properties": { "actions": { "description": "Represents an action that can be applied on he button showing there are more items than the shown", "type": "array", "items": { "$ref": "#/$defs/action" } } } } } }, "ContentType.Calendar.Item": { "description": "Describes each item", "type": "object", "additionalProperties": false, "properties": { "template": { "$ref": "#/$defs/ContentType.Calendar.Item.Template" }, "path": { "description": "Defines the path to the structure holding the data about the items", "type": "string" } } }, "ContentType.Calendar.Item.Template": { "description": "The template for all items", "type": "object", "additionalProperties": false, "properties": { "startDate": { "description": "The start date of the item. The accepted date format is ISO 8601", "type": "string" }, "endDate": { "description": "The end date of the item. The accepted date format is ISO 8601", "type": "string" }, "title": { "description": "The title of the item", "type": "string" }, "text": { "description": "The additional information of the item", "type": "string" }, "icon": { "$ref": "#/$defs/simpleIcon" }, "type": { "description": "The type of the item - one of the types defined in the legend", "oneOf": [ { "enum": [ "Type01", "Type02", "Type03", "Type04", "Type05", "Type06", "Type07", "Type08", "Type09", "Type10", "Type11", "Type12", "Type13", "Type14", "Type15", "Type16", "Type17", "Type18", "Type19", "Type20" ], "default": "Type01" }, { "$ref": "#/$defs/simpleBinding" } ] }, "actions": { "description": "Defines actions that can be applied on the item", "type": "array", "items": { "$ref": "#/$defs/action" } } } }, "ContentType.Calendar.LegendItem": { "description": "Describes each legendItem", "type": "object", "additionalProperties": false, "properties": { "template": { "$ref": "#/$defs/ContentType.Calendar.LegendItem.Template" }, "path": { "description": "Defines the path to the structure holding the data about the legendItems", "type": "string" } } }, "ContentType.Calendar.LegendItem.Template": { "description": "The template for all legendItems", "type": "object", "additionalProperties": false, "properties": { "category": { "description": "Defines which card component describes the legend item. Available categories: \"calendar\" (represented as square) or \"appointment\" (circle)", "type": "string" }, "text": { "description": "The describing information of the item", "type": "string" }, "type": { "description": "The type of the legend item corresponding with the described component", "oneOf": [ { "enum": [ "Type01", "Type02", "Type03", "Type04", "Type05", "Type06", "Type07", "Type08", "Type09", "Type10", "Type11", "Type12", "Type13", "Type14", "Type15", "Type16", "Type17", "Type18", "Type19", "Type20" ], "default": "Type01" }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "ContentType.Calendar.SpecialDate": { "description": "Describes each specialDate", "type": "object", "additionalProperties": false, "properties": { "template": { "$ref": "#/$defs/ContentType.Calendar.SpecialDate.Template" }, "path": { "description": "Defines the path to the structure holding the data about the specialDates", "type": "string" } } }, "ContentType.Calendar.SpecialDate.Template": { "description": "The template for all specialDates", "type": "object", "additionalProperties": false, "properties": { "startDate": { "description": "The start date of the special date. The accepted date format is ISO 8601", "type": "string" }, "endDate": { "description": "The end date of the special date. The accepted date format is ISO 8601", "type": "string" }, "type": { "description": "The type of the special date - one of the types defined in the legend", "oneOf": [ { "enum": [ "Type01", "Type02", "Type03", "Type04", "Type05", "Type06", "Type07", "Type08", "Type09", "Type10", "Type11", "Type12", "Type13", "Type14", "Type15", "Type16", "Type17", "Type18", "Type19", "Type20" ], "default": "Type01" }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "ContentType.AdaptiveCard": { "description": "Represents AdaptiveCard content", "$ref": "https://adaptivecards.io/schemas/adaptive-card.json#/definitions/AdaptiveCard" }, "ContentType.WebPage": { "description": "WebPage content is used to embed HTML page", "type": "object", "additionalProperties": false, "properties": { "data": { "$ref": "#/$defs/data" }, "minHeight": { "$ref": "#/$defs/minHeight" }, "src": { "description": "URL of the web page to be embedded", "type": "string" }, "sandbox": { "description": "Sandbox attribute of the iframe", "type": "string" }, "allow": { "description": "Allow attribute of the iframe", "type": "string" }, "allowFullscreen": { "description": "AllowFullscreen attribute of the iframe", "oneOf": [ { "type": "boolean", "default": false }, { "$ref": "#/$defs/simpleBinding" } ] }, "omitSandbox": { "description": "If set to 'true' the 'sandbox' attribute will not be added to the iframe", "oneOf": [ { "type": "boolean", "default": false }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "progressIndicator": { "description": "Represents progress indicator attributes", "type": "object", "additionalProperties": false, "properties": { "state": { "description": "Represents state color", "oneOf": [ { "$ref": "#/$defs/state" }, { "$ref": "#/$defs/simpleBinding" } ] }, "percent": { "description": "Represents progress indicator percent value", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "text": { "description": "Represents progress indicator text", "type": "string" } } }, "iconWithoutSize": { "description": "Represents icon attributes", "type": "object", "additionalProperties": false, "properties": { "src": { "type": "string", "description": "Represents icon name or source URL" }, "alt": { "type": "string", "description": "Alternative text for the icon" }, "shape": { "type": "string", "description": "Represents the shape of the icon", "oneOf": [ { "enum": [ "Square", "Circle" ], "default": "Circle" }, { "$ref": "#/$defs/simpleBinding" } ] }, "text": { "description": "[Deprecated] Initials for the avatar. Up to 2 symbols. If the image provided to the 'src' property fails to load, then the text will be shown", "deprecated": true, "type": "string" }, "initials": { "description": "Used as fallback if the 'src' property is not set or there is an issue with the resource. Up to two Latin letters can be displayed", "type": "string" }, "backgroundColor": { "$ref": "#/$defs/iconBackgroundColor" }, "fitType": { "description": "Defines how the image fits in the icon area", "oneOf": [ { "enum": [ "Cover", "Contain" ], "default": "Cover" }, { "$ref": "#/$defs/simpleBinding" } ] }, "state": { "description": "Defines the state of the icon", "oneOf": [ { "$ref": "#/$defs/state" }, { "$ref": "#/$defs/simpleBinding" } ] }, "visible": { "description": "Visibility of the icon", "$ref": "#/$defs/visibility" } }, "allOf": [ { "anyOf": [ { "required": ["src"] }, { "required": ["initials"] }, { "required": ["state"] } ] }, { "not": { "anyOf": [ { "required": ["src", "state"] }, { "required": ["initials", "state"] } ] } } ] }, "minHeight": { "description": "Defines the min-height of the Content as a CSS value", "type": "string" }, "icon": { "description": "Represents icon attributes", "type": "object", "additionalProperties": false, "properties": { "src": { "type": "string", "description": "Represents icon name or source URL" }, "alt": { "type": "string", "description": "Alternative text for the icon" }, "shape": { "type": "string", "description": "Represents the shape of the icon", "oneOf": [ { "enum": [ "Square", "Circle" ], "default": "Circle" }, { "$ref": "#/$defs/simpleBinding" } ] }, "text": { "description": "[Deprecated] Initials for the avatar. Up to 2 symbols. If the image provided to the 'src' property fails to load, then the text will be shown", "deprecated": true, "type": "string" }, "initials": { "description": "Used as fallback if the 'src' property is not set or there is an issue with the resource. Up to two Latin letters can be displayed", "type": "string" }, "size": { "description": "[Experimental] The size of the icon", "oneOf": [ { "enum": [ "XS", "S", "M" ] }, { "$ref": "#/$defs/simpleBinding" } ] }, "fitType": { "description": "Defines how the image fits in the icon area", "oneOf": [ { "enum": [ "Cover", "Contain" ], "default": "Cover" }, { "$ref": "#/$defs/simpleBinding" } ] }, "backgroundColor": { "$ref": "#/$defs/iconBackgroundColor" }, "visible": { "description": "Represents the visibility state of the icon", "$ref": "#/$defs/visibility" } } }, "simpleIcon": { "description": "Represents simple icon attributes", "type": "object", "additionalProperties": false, "properties": { "src": { "type": "string", "description": "Represents icon name or source URL" }, "visible": { "description": "Represents the visibility state of the icon", "$ref": "#/$defs/visibility" } } }, "status": { "description": "Represents status attributes", "type": "object", "additionalProperties": false, "properties": { "text": { "description": "Represents status text", "oneOf": [ { "type": "string" }, { "$ref": "#/$defs/statusTextFormatter" } ] }, "visible": { "description": "Represents the visibility of the status text", "$ref": "#/$defs/visibility" } } }, "statusTextFormatter": { "type": "object", "description": "Defines fields for dynamic status formatting", "additionalProperties": false, "properties": { "format": { "description": "Defines binding information", "type": "object", "additionalProperties": false, "properties": { "translationKey": { "type": "string" }, "parts": { "type": "array" } } } } }, "closeButton": { "description": "[Experimental] Represents attributes of the Close button", "type": "object", "additionalProperties": false, "properties": { "visible": { "description": "[Experimental] Represents the visibility of the Close button", "$ref": "#/$defs/visibility" } } }, "data": { "description": "Represents request and response attributes", "type": "object", "additionalProperties": false, "properties": { "request": { "$ref": "#/$defs/request" }, "path": { "description": "The path from the JSON to be used as root", "type": "string", "default": "/", "pattern": "^[a-zA-Z0-9_\\.\\-/|@#]*$" }, "json": { "description": "The data to be used directly. Without making requests", "type": [ "object", "array" ], "additionalProperties": true }, "updateInterval": { "description": "Represents interval in seconds, after which a new data request will be triggered", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "extension": { "$ref": "#/$defs/extension" }, "name": { "description": "[Experimental] Gives a name to the data section. A model with the same name will be assigned to the card", "type": "string" }, "mockData": { "description": "[Experimental] Mock data attributes", "type": "object", "additionalProperties": false, "properties": { "request": { "$ref": "#/$defs/request" }, "json": { "description": "The data to be used directly. Without making requests", "type": [ "object", "array" ], "additionalProperties": true }, "extension": { "$ref": "#/$defs/extension" } } } } }, "request": { "description": "Represents request attributes", "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "mode": { "description": "The mode of the request", "type": "string", "oneOf": [ { "enum": [ "no-cors", "same-origin", "cors" ], "default": "cors" }, { "$ref": "#/$defs/simpleBinding" } ] }, "url": { "description": "The URL to make the request to", "type": "string" }, "method": { "description": "The HTTP method", "type": "string", "oneOf": [ { "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS", "HEAD" ], "default": "GET" }, { "$ref": "#/$defs/simpleBinding" } ] }, "parameters": { "description": "Represents the request parameters. If it is a POST request the parameters will be put as key/value pairs into the body of the request", "type": "object" }, "headers": { "description": "Represents HTTP headers", "type": "object", "additionalProperties": true }, "retryAfter": { "description": "Number of seconds before the request is retried if it failed the previous time", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "timeout": { "description": "A timeout (in milliseconds) for the request. A value of 0 means there will be no timeout", "oneOf": [ { "type": "number", "default": 15000 }, { "$ref": "#/$defs/simpleBinding" } ] }, "withCredentials": { "description": "Indicates whether cross-site requests should be made using credentials", "oneOf": [ { "type": "boolean", "default": false }, { "$ref": "#/$defs/simpleBinding" } ] }, "batch": { "description": "Map of requests to be batched", "type": "object", "additionalProperties": { "$ref": "#/$defs/batchRequest" } }, "cache": { "description": "Cache control settings", "$ref": "#/$defs/cache" } } }, "batchRequest": { "description": "Represents a request which is a part of a batch request", "type": "object", "additionalProperties": false, "required": [ "url", "method" ], "properties": { "url": { "description": "The URL to make the request to", "type": "string" }, "method": { "description": "The HTTP method", "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "headers": { "description": "Represents HTTP headers", "type": "object", "additionalProperties": true }, "body": { "description": "Represents the request body", "additionalProperties": true } } }, "cache": { "description": "Cache control settings", "type": "object", "additionalProperties": false, "properties": { "maxAge": { "description": "The maximum age for which the cache is considered fresh", "type": "number", "default": 0 }, "staleWhileRevalidate": { "description": "Should we show stale cache while revalidating", "type": "boolean", "default": false }, "noStore": { "description": "[Deprecated] Set to true to disable caching for this card", "deprecated": true, "type": "boolean", "default": false }, "enabled": { "description": "Set to false to disable caching for this card", "type": "boolean", "default": false } } }, "extension": { "description": "[Experimental] Represents attributes, needed to get data via extension", "type": "object", "additionalProperties": false, "required": [ "method" ], "properties": { "method": { "description": "The method of the extension, which fetches data", "type": "string" }, "args": { "description": "The arguments, with which the method will be called", "type": "array" } } }, "field": { "type": "object", "additionalProperties": false, "properties": { "label": { "description": "Represents a label of the field; to make this property language dependent (recommended), use a key in double curly brackets '{{key}}'", "$ref": "#/$defs/i18n_key_string", "i18n": { "type": "XFLD", "comment": "Field label" } }, "value": { "type": "string", "description": "The value of the field" }, "visible": { "description": "Represents the visibility of the field", "$ref": "#/$defs/visibility" } } }, "i18n_key_string": { "anyOf": [ { "type": "string", "pattern": "^\\{\\{[\\w][\\w\\.\\-]*\\}\\}$" }, { "type": "string" } ] }, "simpleBinding": { "type": "string", "pattern": "^\\{.*\\}$" }, "action": { "description": "Represents actions that can be applied on card elements", "type": "object", "required": [ "type" ], "additionalProperties": false, "properties": { "type": { "description": "The type of the action", "type": "string", "oneOf": [ { "enum": [ "Custom", "Navigation", "Submit", "ShowCard", "HideCard" ] }, { "$ref": "#/$defs/simpleBinding" } ] }, "navigationArrow": { "description": "Indicates whether a navigation arrow is shown for the item or row. Applicable only to actions of type Navigation.", "oneOf": [ { "type": "boolean" }, { "$ref": "#/$defs/simpleBinding" } ] }, "enabled": { "description": "Represents the state of the action", "oneOf": [ { "type": "boolean" }, { "$ref": "#/$defs/simpleBinding" } ] }, "url": { "description": "[Deprecated] Represents the URL that will be used as navigation target", "deprecated": true, "type": "string" }, "parameters": { "description": "Parameters passed to the navigation action handler" }, "target": { "description": "[Deprecated] Specifies where to open the 'url', if it is provided", "deprecated": true, "type": "string", "oneOf": [ { "$ref": "#/$defs/target" }, { "$ref": "#/$defs/simpleBinding" } ] } }, "allOf": [ { "if": { "properties": { "type": { "const": "Custom" } } }, "then": { "properties": { "parameters": { "$ref": "#/$defs/customActionParameters" } } } }, { "if": { "properties": { "type": { "const": "Navigation" } } }, "then": { "properties": { "parameters": { "oneOf": [ { "$ref": "#/$defs/navigationActionParameters" }, { "$ref": "#/$defs/navigationActionIBParameters" } ] } } } }, { "if": { "properties": { "type": { "const": "Submit" } } }, "then": { "properties": { "parameters": { "$ref": "#/$defs/submitActionParameters" } } } }, { "if": { "properties": { "type": { "const": "ShowCard" } } }, "then": { "properties": { "parameters": { "$ref": "#/$defs/showCardActionParameters" } } } }, { "if": { "properties": { "type": { "const": "HideCard" } } }, "then": { "properties": { "parameters": { "$ref": "#/$defs/hideCardActionParameters" } } } } ] }, "navigationActionParameters": { "description": "Parameters for Navigation action", "type": "object", "additionalProperties": false, "required": [ "url" ], "properties": { "url": { "type": "string" }, "target": { "type": "string" } } }, "navigationActionIBParameters": { "description": "Parameters for Intent-Based Navigation action", "type": "object", "additionalProperties": false, "required": [ "ibnTarget" ], "properties": { "ibnTarget": { "description": "An application identifier consisting of semanticObject and action", "$ref": "#/$defs/ibnTarget" }, "ibnParams": { "description": "Key/value pairs for parameters of the target application", "type": "object" }, "ibnAppSpecificRoute": { "description": "An application specific route that is passed to the target application", "type": "string" } } }, "submitActionParameters": { "description": "Parameters for Submit action", "type": "object", "additionalProperties": false }, "showCardActionParameters": { "description": "Parameters for ShowCard action", "type": "object", "additionalProperties": false, "properties": { "childCardKey": { "description": "The key of the card to be shown", "type": "string" }, "manifest": { "deprecated": true, "description": "[Deprecated] Child card manifest", "oneOf": [ { "type": "string" }, { "type": "object" } ] }, "parameters": { "type": "object" }, "data": { "type": "object" }, "width": { "type": "string" }, "baseUrl": { "type": "string" }, "resizable": { "oneOf": [ { "type": "boolean" }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "customActionParameters": { "description": "Parameters for Custom action", "type": "object", "additionalProperties": true }, "hideCardActionParameters": { "description": "Parameters for HideCard action", "type": "object", "additionalProperties": false }, "ibnTarget": { "description": "The application identifier consisting of semanticObject and action or ", "type": "object", "additionalProperties": false, "required": [ "semanticObject", "action" ], "properties": { "semanticObject": { "type": "string" }, "action": { "type": "string" } } }, "state": { "description": "Represents state of an entity", "type": "string", "enum": [ "Error", "Success", "Warning", "None", "Information" ], "default": "None" }, "textAlign": { "description": "Represents options for text alignments", "type": "string", "enum": [ "Begin", "Center", "End", "Initial", "Left", "Right" ], "default": "Begin" }, "target": { "description": "Specifies where to open an URL", "type": "string", "enum": [ "_blank", "_self" ], "default": "_blank" }, "identifier": { "description": "Represents identifier", "oneOf": [ { "type": "boolean", "default": false }, { "type": "object", "additionalProperties": false, "description": "[Deprecated]", "deprecated": true, "properties": { "url": { "type": "string" }, "target": { "$ref": "#/$defs/target" } } } ] }, "Configuration.BasicDataType": { "description": "Basic data types for parameters and filters", "type": "string", "enum": [ "string", "integer", "number", "boolean", "date", "datetime" ] }, "Configuration.Parameter": { "description": "Represents configuration parameter", "type": "object", "additionalProperties": false, "properties": { "value": { "description": "The value of the parameter" }, "type": { "description": "The type of the value for the parameter", "$ref": "#/$defs/Configuration.BasicDataType" }, "label": { "description": "Label for the parameter for user-friendly visualization in the design-time editor", "type": "string" }, "description": { "description": "Description of the parameter for user-friendly visualization in the design-time editor", "type": "string" } } }, "Configuration.FilterType.Select": { "description": "Select filter", "type": "object", "additionalProperties": false, "properties": { "type": { "description": "The type of the filter", "oneOf": [ { "const": "Select" }, { "$ref": "#/$defs/simpleBinding" } ] }, "value": { "description": "The value of the filter" }, "data": { "$ref": "#/$defs/data" }, "label": { "description": "Label for the filter. Used by screen readers", "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/$defs/Configuration.Filter.Item" } }, "item": { "type": "object", "required": [ "template" ], "properties": { "template": { "$ref": "#/$defs/Configuration.Filter.Item" }, "path": { "description": "Defines the path to the structure holding the data about the items", "type": "string", "default": "/", "pattern": "^[a-zA-Z0-9_\\.\\-/|@#]*$" } } }, "visible": { "description": "Determines whether the filter is visible", "$ref": "#/$defs/visibility" } } }, "Configuration.FilterType.ComboBox": { "description": "[Experimental] ComboBox filter", "type": "object", "additionalProperties": false, "properties": { "type": { "description": "The type of the filter", "oneOf": [ { "const": "ComboBox" }, { "$ref": "#/$defs/simpleBinding" } ] }, "value": { "description": "The value of the filter" }, "selectedKey": { "description": "Defines the initially selected key from the given options for combo box", "type": "string" }, "selectedIndex": { "description": "Specifies the index of the selected item. Index value for no selection is -1", "oneOf": [ { "type": "number", "default": -1 }, { "$ref": "#/$defs/simpleBinding" } ] }, "data": { "$ref": "#/$defs/data" }, "label": { "description": "Label for the filter. Used by screen readers", "type": "string" }, "placeholder": { "description": "The placeholder of the filter", "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/$defs/Configuration.Filter.ComboBoxItem" } }, "item": { "type": "object", "additionalProperties": false, "required": [ "template" ], "properties": { "template": { "$ref": "#/$defs/Configuration.Filter.ComboBoxItem" }, "path": { "description": "Defines the path to the structure holding the data about the items", "type": "string", "default": "/", "pattern": "^[a-zA-Z0-9_\\.\\-/|@#]*$" } } }, "group": { "$ref": "#/$defs/group" }, "visible": { "description": "Determines whether the filter is visible", "$ref": "#/$defs/visibility" } } }, "Configuration.Filter.Item": { "description": "A single filter selection option", "type": "object", "additionalProperties": false, "properties": { "title": { "description": "The title of the filter option", "type": "string" }, "key": { "description": "The unique key of the filter option. Mapped to the filter's value", "type": "string" } } }, "Configuration.Filter.ComboBoxItem": { "description": "A single Combo Box filter selection option", "type": "object", "additionalProperties": false, "properties": { "title": { "description": "The title of the filter option", "type": "string" }, "key": { "description": "The unique key of the filter option. Mapped to the filter's value", "type": "string" }, "additionalText": { "description": "The secondary value for the combo box item", "type": "string" } } }, "Configuration.FilterType.DateRange": { "description": "Date range filter", "type": "object", "additionalProperties": false, "properties": { "type": { "description": "The type of the filter", "oneOf": [ { "const": "DateRange" }, { "$ref": "#/$defs/simpleBinding" } ] }, "label": { "description": "Label for the filter. Used by screen readers", "type": "string" }, "placeholder": { "description": "Placeholder for the filter's input", "type": "string" }, "value": { "type": "object", "additionalProperties": false, "properties": { "option": { "description": "The date range option", "type": "string" }, "values": { "type": "array" } } }, "options": { "description": "Options that will appear in the dropdown", "type": "array", "items": { "type": "string", "enum": [ "date", "today", "yesterday", "tomorrow", "dateRange", "dateTimeRange", "from", "to", "fromDateTime", "toDateTime", "yearToDate", "lastDays", "lastWeeks", "lastMonths", "lastQuarters", "lastYears", "nextDays", "nextWeeks", "nextMonths", "nextQuarters", "nextYears", "todayFromTo", "thisWeek", "lastWeek", "nextWeek", "specificMonth", "thisMonth", "lastMonth", "nextMonth", "thisQuarter", "lastQuarter", "nextQuarter", "quarter1", "quarter2", "quarter3", "quarter4", "thisYear", "lastYear", "nextYear", "dateTime" ] } }, "visible": { "description": "Determines whether the filter is visible", "$ref": "#/$defs/visibility" } } }, "Configuration.FilterType.Search": { "description": "Search filter", "type": "object", "additionalProperties": false, "properties": { "type": { "description": "The type of the filter", "oneOf": [ { "const": "Search" }, { "$ref": "#/$defs/simpleBinding" } ] }, "label": { "description": "Label for the filter. Used by screen readers", "type": "string" }, "value": { "description": "The value of the filter", "type": "string" }, "placeholder": { "description": "The placeholder of the filter", "type": "string" }, "visible": { "description": "Determines whether the filter is visible", "$ref": "#/$defs/visibility" } } }, "Configuration.Destinations": { "description": "Represents a configuration for a cloud platform destination", "type": "object", "additionalProperties": false, "properties": { "name": { "description": "The name of the destination. Use the same name which is used in Cloud Platform", "type": "string" }, "label": { "description": "Label for the destination for user-friendly visualization in the design-time editor", "type": "string" }, "description": { "description": "Description of the destination for user-friendly visualization in the design-time editor", "type": "string" }, "defaultUrl": { "description": "A default url which will be used if there is no Host associated with the card", "type": "string" } } }, "Configuration.CSRFToken": { "description": "Represents a configuration for a CSRF token", "type": "object", "additionalProperties": false, "properties": { "data": { "$ref": "#/$defs/data" } } }, "Configuration.NoData": { "description": "Represents a configuration for a NoData", "type": "object", "additionalProperties": false, "properties": { "title": { "description": "Title shown in the illustrated message of the card", "type": "string" }, "description": { "description": "Description shown in the illustrated message of the card", "type": "string" }, "size": { "description": "Defines the size predefined from sap.m.IllustratedMessage", "type": "string" }, "type": { "description": "Defines the image predefined from sap.m.IllustratedMessage", "type": "string" } } }, "Configuration.ChildCard": { "description": "Represents a configuration for a child card", "type": "object", "additionalProperties": false, "required": [ "manifest" ], "properties": { "manifest": { "description": "The manifest of the child card", "type": "string" } } }, "MicroChart": { "description": "[Experimental] Describes MicroChart attributes", "oneOf": [ { "$ref": "#/$defs/MicroChart.Generic" }, { "$ref": "#/$defs/MicroChart.Bullet" }, { "$ref": "#/$defs/MicroChart.StackedBar" } ] }, "MicroChart.Generic": { "type": "object", "additionalProperties": true, "required": [ "type" ], "properties": { "type": { "description": "Represents the type of the MicroChart", "type": "string", "enum": [ "Line", "Column", "HarveyBall", "Radial" ] } } }, "MicroChart.Bullet": { "type": "object", "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "description": "Represents the type of the MicroChart", "type": "string", "const": "Bullet" }, "value": { "description": "The actual value shown as a colored horizontal bar", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "minValue": { "description": "The minimum scale value for the bar chart", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "maxValue": { "description": "The maximum scale value for the bar chart", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "displayValue": { "description": "The actual value, which will be displayed as a text next to the bar", "type": "string" }, "target": { "description": "The target value - displayed as a vertical line (marker)", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "scale": { "description": "The scaling suffix that is appended to all values", "type": "string" }, "color": { "description": "The state color of the bar", "type": "string", "oneOf": [ { "$ref": "#/$defs/Enums.ValueColor" }, { "$ref": "#/$defs/simpleBinding" } ] }, "thresholds": { "description": "The thresholds indicators of the bar", "type": "array", "items": { "$ref": "#/$defs/MicroChart.Bullet.Threshold" } }, "visible": { "description": "Represents the visibility of the chart", "$ref": "#/$defs/visibility" } } }, "MicroChart.Bullet.Threshold": { "type": "object", "additionalProperties": false, "properties": { "value": { "description": "The value of the threshold", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "color": { "description": "The state color of the threshold", "type": "string", "oneOf": [ { "$ref": "#/$defs/Enums.ValueColor" }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "MicroChart.StackedBar": { "type": "object", "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "description": "Represents the type of the MicroChart", "type": "string", "const": "StackedBar" }, "maxValue": { "description": "The maximum scale value for the bar chart", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "displayValue": { "description": "The value, which will be displayed as a text next to the bar", "type": "string" }, "displayZeroValue": { "description": "Defines whether bars with zero values are displayed", "oneOf": [ { "type": "boolean", "default": true }, { "$ref": "#/$defs/simpleBinding" } ] }, "bars": { "description": "The bars of the chart", "type": "array", "items": { "$ref": "#/$defs/MicroChart.StackedBar.Bar" } }, "visible": { "description": "Represents the visibility of the chart bar", "$ref": "#/$defs/visibility" } } }, "MicroChart.StackedBar.Bar": { "type": "object", "additionalProperties": false, "properties": { "value": { "description": "The actual value shown as a colored horizontal bar", "oneOf": [ { "type": "number" }, { "$ref": "#/$defs/simpleBinding" } ] }, "displayValue": { "description": "The value, which will be displayed as a text in the tooltip of the bar", "type": "string" }, "legendTitle": { "description": "Title, which will be displayed in the legend", "type": "string" }, "color": { "description": "The color of the bar", "type": "string", "oneOf": [ { "$ref": "#/$defs/Enums.ValueColor" }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "Enums.ValueColor": { "enum": [ "Critical", "Error", "Good", "Neutral" ], "default": "Neutral" }, "visibility": { "oneOf": [ { "type": "boolean", "default": true }, { "$ref": "#/$defs/simpleBinding" } ] }, "wrappingType": { "description": "The wrapping type for texts", "type": "string", "oneOf": [ { "enum": [ "Normal", "Hyphenated" ], "default": "Normal" }, { "$ref": "#/$defs/simpleBinding" } ] }, "iconBackgroundColor": { "oneOf": [ { "enum": [ "Accent1", "Accent2", "Accent3", "Accent4", "Accent5", "Accent6", "Accent7", "Accent8", "Accent9", "Accent10", "Placeholder", "Random", "TileIcon", "Transparent" ], "default": "Transparent" }, { "$ref": "#/$defs/simpleBinding" } ] }, "actionsStrip": { "type": "object", "additionalProperties": false, "properties": { "item": { "$ref": "#/$defs/actionsStripItemBindingInfo" } } }, "actionsStripItemBindingInfo": { "type": "object", "description": "[Experimental] Binding info for items of type actionsStripItem", "additionalProperties": false, "properties": { "template": { "$ref": "#/$defs/actionsStripItem" }, "path": { "type": "string" } } }, "actionsStripItem": { "description": "Attributes of actions strip item", "type": "object", "additionalProperties": false, "properties": { "actions": { "description": "Action(s) which will be executed when button is pressed", "type": "array", "items": { "$ref": "#/$defs/action" } }, "type": { "description": "The type of the item", "oneOf": [ { "enum": [ "Button", "ToolbarSpacer", "Link", "Label" ], "default": "Button" }, { "$ref": "#/$defs/simpleBinding" } ] }, "overflowPriority": { "description": "Defines items priority", "oneOf": [ { "enum": [ "AlwaysOverflow", "Disappear", "High", "Low", "NeverOverflow" ], "default": "High" }, { "$ref": "#/$defs/simpleBinding" } ] }, "icon": { "description": "The icon of the item", "type": "string" }, "text": { "description": "The text of the item", "type": "string" }, "tooltip": { "description": "The tooltip of the item", "type": "string" }, "buttonType": { "description": "The type of the button", "oneOf": [ { "enum": [ "Accept", "Attention", "Back", "Critical", "Default", "Emphasized", "Ghost", "Negative", "Neutral", "Reject", "Success", "Transparent", "Unstyled", "Up" ], "default": "Default" }, { "$ref": "#/$defs/simpleBinding" } ] }, "ariaHasPopup": { "description": "Use this property only when the item is related to a popover/popup", "oneOf": [ { "enum": [ "Dialog", "Grid", "ListBox", "Menu", "None", "Tree" ], "default": "None" }, { "$ref": "#/$defs/simpleBinding" } ] }, "visible": { "description": "Determines whether the item is visible", "$ref": "#/$defs/visibility" }, "preferIcon": { "description": "Defines whether the button will shown icon only when placed in the visible area. This will save space in the actions strip. When in the overflow area, it will always show both icon and text", "oneOf": [ { "type": "boolean" }, { "$ref": "#/$defs/simpleBinding" } ] } } }, "group": { "description": "Represents group of items", "type": "object", "additionalProperties": false, "properties": { "title": { "description": "The title of the group", "type": "string" }, "order": { "description": "The order by which the group will be sorted", "type": "object", "additionalProperties": false, "properties": { "path": { "description": "Defines the path to the structure holding the data about the group order", "type": "string" }, "dir": { "description": "The sorting direction in which the group items will be ordered", "oneOf": [ { "enum": [ "ASC", "DESC" ], "default": "ASC" } ] } } } } }, "justifyContent": { "description": "Defines how the space is distributed between and around content items", "type": "string", "oneOf": [ { "enum": [ "SpaceBetween", "Start", "End" ], "default": "SpaceBetween" }, { "$ref": "#/$defs/simpleBinding" } ] }, "objectStatus": { "description": "Represents value and state information for an object", "type": "object", "additionalProperties": false, "properties": { "type": { "description": "Represents the type of the object", "type": "string", "enum": [ "Status" ] }, "value": { "type": "string", "description": "The value of the field" }, "state": { "description": "The state of the field", "oneOf": [ { "$ref": "#/$defs/state" }, { "$ref": "#/$defs/simpleBinding" } ] }, "showStateIcon": { "description": "Defines if a default state icon is shown", "oneOf": [ { "type": "boolean" }, { "$ref": "#/$defs/simpleBinding" } ] }, "customStateIcon": { "description": "The custom state icon", "type": "string" }, "visible": { "description": "Visibility of the item", "$ref": "#/$defs/visibility" }, "title": { "description": "Title of the data point. This is just a placeholder to store the title, title will not be rendered on the screen. This is needed to prevent the loss of column names while transforming table card to list card", "type": "string" }, "inverted": { "description": "Specifies whether the background color reflects the set \"state\" instead of the control's text", "oneOf": [ { "type": "boolean" }, { "$ref": "#/$defs/simpleBinding" } ] }, "actions": { "description": "Actions that can be applied on the status", "type": "array", "items": { "$ref": "#/$defs/action" } } } } } }