ChartCard¶
ChartCard Properties¶
| Property | Type | Required | Default |
|---|---|---|---|
| ChartType | enum |
Optional | "Line" |
| DataSeries | object |
Optional | |
| DataSubscriptions | DataSubscriptions | Optional | |
| IsTrendUpward | boolean |
Optional | |
| LeadingUnit | string |
Optional | |
| Metric | string |
Optional | |
| NoDataText | string |
Optional | |
| SeriesColor | string[] |
Optional | |
| SeriesTitle | string[] |
Optional | |
| StatusText | string |
Optional | |
| Styles | object |
Optional | |
| Subtitle | string |
Optional | |
| Target | LinkQueryFunctionTarget | Optional | |
| Title | string |
Optional | |
| TrailingUnit | string |
Optional | |
| TrendImage | Image | Optional | |
| TrendTitle | string |
Optional | |
| _Name | string |
Optional | |
| _Type | const |
Required |
ChartType¶
Chart type of the chart card.
In Android, scrolling is not supported for bar type and only two data series can be displayed. In iOS, scrolling is supported for bar type.
- type:
enum - default:
"Line"
The value of this property must be equal to one of the known values below.
ChartType Known Values¶
| Value | Description |
|---|---|
Line |
|
Column |
|
Bar |
DataSeries¶
- type:
objectwith following properties.
| Property | Type | Required | Default |
|---|---|---|---|
Data |
array | Optional | |
CategoryTitles |
array | Optional | |
CategoryLabelVisible |
boolean | Optional | |
NumericLabelVisible |
boolean | Optional |
Data¶
Array of arrays containing specific data elements
- type:
array[]
CategoryTitles¶
CategoryTitles is compulsory, no fallback maintained; Android only renders even numbered array elements when specified; In iOS, CategoryTitles only displays first and last elements of the array; Number of values in Data and CategoryTitles must be the same for the last value of CategoryTitles to be displayed.
- type:
string[]
CategoryLabelVisible¶
iOS only. Whether to show the category label.
NumericLabelVisible¶
iOS only. Whether to show the numerical label.
DataSubscriptions¶
Array of data change events to subscribe to.
- type: DataSubscriptions
IsTrendUpward¶
Android only. Use TrendImage for iOS. Set IsTrendUpward to true for positive trend and is styled with color
Green. Set IsTrendUpward to false for negative trend and is styled with color Red.
- type:
boolean
LeadingUnit¶
- type:
string
Metric¶
- type:
string
NoDataText¶
Placeholder text when chart data is not available. If this is absent, no text will be displayed when chart data is empty.
- type:
string
SeriesColor¶
Can be a hex string, e.g. #fcba03 or color string. e.g. blue. iOS only, it is not configurable in Android.
- type:
string[]
All items must be of the type: string
SeriesTitle¶
- type:
string[]
All items must be of the type: string
StatusText¶
- type:
string
Styles¶
- type:
objectwith following properties.
| Property | Type | Required | Default |
|---|---|---|---|
| Title | string |
Optional | |
| Subtitle | string |
Optional | |
| StatusText | string |
Optional | |
| SeriesTitle | string |
Optional | |
| TrendTitle | string |
Optional | |
| TrendImage | string |
Optional | |
| NoDataText | string |
Optional |
Title¶
The string value is a style class name for Title.
- Text style class
Subtitle¶
The string value is a style class name for Subtitle. iOS only.
- Text style class
StatusText¶
The string value is a style class name for StatusText.
- Text style class
SeriesTitle¶
The string value is a style class name for SeriesTitle. Can only be styled in iOS.
- Text style class
TrendTitle¶
The string value is a style class name for TrendTitle.
- Text style class
TrendImage¶
The string value is a style class name for TrendImage. iOS only.
- Image style class
NoDataText¶
The string value is a style class name for NoDataText. Android only. font-typeface attribute not supported.
- Text style class
Subtitle¶
iOS only. If Subtitle is set, then TrendTitle will be ignored.
- type:
string
Target¶
Definition of the target binding to dynamically populate the collection. You can also set this to binding/rule to return an array of data items.
Note: If this is set to binding/rule, you must return an array of data items, you can't return Target definition.
- type: LinkQueryFunctionTarget
Title¶
- type:
string
TrailingUnit¶
- type:
string
TrendImage¶
iOS only. Use IsTrendUpward for Android.
- type: Image
TrendTitle¶
In iOS, if Subtitle is also set, then TrendTitle will be ignored.
- type:
string
_Name¶
- type:
string
_Type¶
- type:
const
The value of this property must be equal to:
"Card.Type.Chart"