Visualisation Definition

The visualisation definition is responsible for:

  • specifying the type of visualisation.
  • creating the Visualisation dataset.
  • defining the presentation information required to render the visualisation correctly.

contents

Visualisation Types

  • list
  • bar
  • bar-timeseries
  • dougnhut
  • line
  • line-timeseries
  • matrix-timeseries
  • scorecard
  • scorecard-group

Definition

All visualisation types share the same common definition attributes:

Name Type Required Description
id string Yes The visualisation ID
type string Yes The visualisation type See Visualisation types
display string no The visualisation title
description string no The visualisation desciption
column object yes The dataset colums definition. See Columns
option object no Set specific option per visualisation type Options

Options

Name Type Required Description
columnsAsList boolean no default value: false. Specific to List visualisation
showLatest boolean no default value: true. Specific to List visualisation
useRagColour boolean no default value: false. Specific to Bucketed visualisations
baseColour string No dDefault: #1d70b8. Specific to Bucketed visualisations
bucket Array No Defines the custom buckets. Specific to Bucketed visualisations

Columns

The columns definition is responsible for targeting the data required by the visualisation.

See Targeting data in a dataset for usage.

Name Type Required Description
key array Yes The array of key columns. See Key
measure array Yes The array of measure columns. See Measure
filter array no The array of filter columns. See Filter
expectNull boolean no Targets rows based on whether columns contain null/undefined values. See here for example usage

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