Visualisation Definition

The visualisation definition is responsible for:

• specifying the type of visualisation
• retriveing the data needed for the visualisation from a single dataset
• defining the presentation information required to render the visualisation correctly

All visualisation types share the same common definition attributes:

Name	Type	Required	Description
id	string	Yes	The visualisation ID
type	list bar dougnhut line scorecard scorecard-group	Yes	The visualisation type
display	string	no	The visualisation title
description	string	no	The visualisation desciption
columns	object	yes	The dataset colums definition. See Columns
columnsAsList	boolean	no	default value: false. Specific to List visualisation
showLatest	boolean	no	default value: true. Determines whether to include historic data

Columns

The columns definition is responsible for targeting the required visualisation data from a dataset. See Targeting data in a dataset for usage.

Name	Type	Required	Description
keys	array	Yes	The array of key column data. See Key
measures	array	Yes	The array of measure column data. See Measure
filters	array	no	The array of filter column data. See Filter
expectNulls	boolean	no	See expectNulls

Key

Name	Type	Required	Description
id	string	Yes	The id/column name of the column within the dataset
display	string	no	The display name of the column
optional	boolean	no	Defines whether the key is optional

Measure

Name	Type	Required	Description
id	string	Yes	The id/column name of the column within the dataset
display	string	no	The display name of the column
aggregate	sum	no	The aggregation operation
unit	number, percentage	no	The unit type. Default: number
axis	x,y	no	specific to bar visualisation types

Filter

Name	Type	Required	Description
id	string	Yes	The id/column name of the column within the dataset
equals	string	Yes	The value the column should match