Visualizations¶

Visualizations picture the data for a single resource. The available visualizations differ based on the type of data to be displayed.

Table¶

Note

Tables are available for CSV and JSON data.

Tables are the default visualization for CSV and JSON data. They do not take any additional configuration options and may be omitted in the configuration.

Example

app.config.yml

visualizations:
    table: {}

Bar Chart¶

Note

Bar charts are available for CSV and JSON data.

In addition to tables, CSV and JSON data can be visualized as bar charts. For that, the axes need to be configured.

Example

app.config.yml

visualizations:
    barChart:
        layout: string # (1)!
        axisPairs: [<axis-pair>] # (2)!

The layout/orientation of the chart.
A list of axis pairs.

Layout¶

Optionally, specify the layout of the bar chart.

By default, the horizontal layout (horizontal) will be used.
Alternatively, a vertical layout (vertical) can be used instead.

Example

app.config.yml

layout: string

Axis Pairs¶

Specify the axis configurations for a Bar Chart as a list of objects containing xAxis and yAxis properties.

Example

app.config.yml

axisPairs: [<axis-pair>]

Note

Make sure the properties for yAxis always return numeric values.

An actual config setting the axis configurations would look like this:

Example

app.config.yml

axisPairs:
- xAxis: test_prop_str
  yAxis: test_prop_int
- xAxis: test_prop_str
  yAxis: test_prop_float

Map¶

Note

Maps are available for GeoJSON data.

GeoJSON data can be visualized as maps.

Example

app.config.yml

visualizations:
    map:
        groupKey: string # (1)!

A group key.

Group Key¶

Optionally, specify a group key to divide the data into categories. The categories will be displayed in the map legend with each having a unique marker color.

Example

app.config.yml

groupKey: category