SingleDataChartViewTemplate
This page provides generated reference documentation for the SingleDataChartViewTemplate data model.
Displays single-dimensional data in a chart, with the data source being certain fields of a special entity. In property "chartType", you can select from a list of various chart types, e.g., "DONUT".
Overview
| Property | Summary |
|---|---|
| title | Title of the component |
| devices | Determines on wich devices the component should be available. The default value states that the component is available on all devices. If one or more devices… |
| children | List of children in this container |
| entityField | This property is mandatory. Its value must be set to |
| informationField | Defines the field which provides additional information. The placement of the information label varies between the ViewTemplates. The information label is only… |
| xAxis | Specifies the entityfield in which the x-axis values are. |
| yAxis | Defines the entityfield in which the values of the y-axis are. |
| parentField | Defines the entityfield in which the ParentID is located. |
| colorField | Defines the entityfield in which the color of each value in the chart is located. e.g. if the value provided in this field is "brand-color" then the item in… |
| chartType | Specifies the display of the chart: |
| showDataLabelValues | Specifies if the data labels of the chart should show the actual numeric values. |
| dataLabelPositionInside | Specifies if the data labels should be shown inside the data points. Currently not supported in pie / donut charts. |
| colspan | The colspan of the element. |
| rowspan | The rowspan of the element. |
title
Type: String
Constraints: Verification: TITLE_LENGTH
Title of the component
devices
Type: EDeviceType[]
Determines on wich devices the component should be available. The default value states that the component is available on all devices. If one or more devices are selected then the component is only available for those selected devices.
children
Type: Children
List of children in this container
entityField
Type: String
This property is mandatory. Its value must be set to\
- #ENTITY, when the ViewTemplate uses multiple EntityFields of the Entity belonging to the View (default).\
- a single EntityField, if the ViewTemplate uses only this one single EntityField (example: WebContentViewTemplate).
The second option will result in a performance optimization.
informationField
Type: String
Defines the field which provides additional information. The placement of the information label varies between the ViewTemplates. The information label is only shown once per ViewTemplate.
xAxis
Type: String
Specifies the entityfield in which the x-axis values are.
yAxis
Type: String
Defines the entityfield in which the values of the y-axis are.
parentField
Type: String
Defines the entityfield in which the ParentID is located.
This serves as the parent/child mapping for chart drilldown or mapping for the rows of a TreeTable.
colorField
Type: String
Defines the entityfield in which the color of each value in the chart is located. e.g. if the value provided in this field is "brand-color" then the item in the chart will be rendered in this color.
chartType
Type: ENeonSingleDataChartType
Specifies the display of the chart:
- NeonSingleDataChart: DONUT, FUNNEL, PIE, PYRAMID
showDataLabelValues
Type: Boolean
Specifies if the data labels of the chart should show the actual numeric values.
dataLabelPositionInside
Type: Boolean
Requires: showDataLabelValues property group
Specifies if the data labels should be shown inside the data points. Currently not supported in pie / donut charts.
colspan
Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE
The colspan of the element.
rowspan
Type: Integer
Default: 1
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE
The rowspan of the element.