Schema for configuring the look and feel of a patient chart.
No Additional PropertiesTitle of the chart for display to the user. Will be passed through i18n.
Must be at least 1
characters long
subtitle of the chart for display to the user. Will be passed through i18n.
Must be at least 1
characters long
Type of the chart, either scatter
, singleLine
or multiLine
.
key identifying which chart is being display. i.e HR, BP
Must be at least 1
characters long
For example in the case of Alexandra, we combine the BG data Reading values with time taken (i.e After Meal, before Meal, etc...)
Use to determine if we do the sorting manually or use the predefined sorting functionality that comes with the library
Props for configuring the legend of the series. It will be passed to VictoryLegend
. If not specified, legends will not be used for the chart.
Unit associated with the average result. i.e %, °C.
Must be at least 1
characters long
How many decimal places to show after each entry. ie. 1
Value must be greater or equal to 0
Clinical parameters that will be displayed on this chart. This will be used to filter submission values in GQL (and reduce network traffic). It can be either name
or uid
of parameter. Defaults to returning all parameter values.
Must contain a minimum of 1
items
Must be at least 1
characters long
Representation of the graph in table view, columns definition. The properties of these columns are similar to the table config
Must contain a minimum of 1
items
Additional Properties of any type are allowed.
Type: objectSettings for each series to display in the chart.
Must contain a minimum of 1
items
Title of the line / series. This will be used for default in legends, etc.
Must be at least 1
characters long
Props for configuring the symbols/data points of the series. It will be passed to the chart as style.data
.
Props for configuring the line of the series. It will be passed to the chart as style.data
. This is only applicable for line
charts.
Template string defining how tooltips for data points are shown. Supported variables are:
- ${submission[uid]}
: UID of submission.
- ${submission[created_on]}
: Submission date of submission.
- ${submission_value[<name_with_group>]}
: Submission value for clinical parameter name_with_group
. Example: ${submission_value[BP Systolic]}
.
- ${submission_value[<uid>]}
: Submission value for clinical parameter with UID uid
. Example: ${submission_value[xxxxx123456789012345678901234567]}
.
Must be at least 1
characters long