Skip to content

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

For Bar type, In Android, Scroll is not allowed and only two data series will be displayed for multiple data series. In iOS, Scrolling is supported in 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: object with 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; CategoryTitles in case of iOS, only first and last elements of the array is displayed; Make sure the number of values in Data and CategoryTitles are same to have the last value of CategoryTitles displayed

  • type: string[]

CategoryLabelVisible

NumericLabelVisible


DataSubscriptions

Array of data change events to subscribe to.


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: object with 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.

Subtitle

The string value is a style class name for Subtitle. iOS only.

StatusText

The string value is a style class name for StatusText.

SeriesTitle

The string value is a style class name for SeriesTitle. Can only be styled in iOS.

TrendTitle

The string value is a style class name for TrendTitle.

TrendImage

The string value is a style class name for TrendImage. iOS only.

NoDataText

The string value is a style class name for NoDataText. Android only. font-typeface attribute not supported.


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.


Title

  • type: string

TrailingUnit

  • type: string

TrendImage

iOS only. Use IsTrendUpward for Android.


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"