Timeline

Various types of timeline visualizations

Updated 3 years ago to v0.9.0-prerelease.1 by Flourish team

How to use this template

Timeline

This section documents API usage specific to this template, so for an introduction we suggest you refer to the generic API documentation instead.

template: @flourish/timeline

version: 0

Template data

There are three different formats in which you can supply data to this template. The most convenient for you to use likely depends on the source of your data, as described below.

1. Array of arrays, and a bindings object

You can supply arrays of arrays to opts.data, which might look like:

{
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

where each array of arrays represents the rows in a data sheet.

To tell the API how the values from each column should be associated with the keys that the template is expecting, you must also supply an object attached to opts.bindings. (The meanings of the keys in the bindings object are documented below.) The minimal bindings you can supply for this template are as shown in this example:

{
    template: "@flourish/timeline",
    version: "0",
    bindings: {
        data: {
            time_start: 0, // index of a column in your data
            category: 2, // index of a column in your data
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

All possible bindings that you can supply are shown in this example:

{
    template: "@flourish/timeline",
    version: "0",
    bindings: {
        data: {
            time_start: 0, // index of a column in your data
            time_end: 1, // index of a column in your data
            category: 2, // index of a column in your data
            title: 3, // index of a column in your data
            subtitle: 4, // index of a column in your data
            content: [5, 6, ...], // index(es) of column(s) in your data
            value: 7, // index of a column in your data
            priority: 8, // index of a column in your data
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

2. Array of objects with arbitrary keys, and a bindings object

This format is most likely useful when you have data from an external source, such as CSV data loaded from d3-dsv. You should supply this attached to the opts.data, which might look like:

{
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }

... but with the keys being the column headers from your source data instead. You must also supply an object attached to opts.bindings. The minimal bindings you can supply for this template are as shown in this example:

{
    template: "@flourish/timeline",
    version: "0",
    bindings: {
        data: {
            time_start: "DataHeader1",
            category: "DataHeader3",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

All possible bindings that you can supply are shown in this example:

{
    template: "@flourish/timeline",
    version: "0",
    bindings: {
        data: {
            time_start: "DataHeader1",
            time_end: "DataHeader2",
            category: "DataHeader3",
            title: "DataHeader4",
            subtitle: "DataHeader5",
            content: ["DataHeader6", "DataHeader7", ...],
            value: "DataHeader8",
            priority: "DataHeader9",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

(As before, the keys containing "Header" would be replaced by column names from your data source.)

3. Array of objects with template-defined keys

There is an alternative format you can use, which is likely to be easier to use if your data is not from a spreadsheet source. With this alternative format you supply your data to the template as an array of objects, attached to opts.data, where the keys must be those used by the template, as documented below. In this case there is no need to supply a bindings object, since the key names are already those expected by the template. The required properties in the data object are as follows (scroll down for a description of what each property is):

{
    template: "@flourish/timeline",
    version: "0",
    data: {
    data: [
        {
            time_start: ...,
            category: ...,
            content: [...]
        },
        ...
    ]
},
    ...
}

And the full list of all possible properties is as follows:

{
    template: "@flourish/timeline",
    version: "0",
    data: {
    data: [
        {
            time_start: ...,
            time_end: ...,
            category: ...,
            title: ...,
            subtitle: ...,
            content: [...],
            value: ...,
            priority: ...
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

  • data.time_start: time_start
  • data.time_end: time_end
  • data.category: category
  • data.title: Title of the label
  • data.subtitle: Subtitle of the label
  • data.content: Content to display inside the data point
  • data.value: value
  • data.priority: Would be used to highlight desired data points

Template settings

Options for opts.state.

Timeline

widescreen_mode string

Widescreen mode.

Allowed values:

  • events-horizontal (Horizontal)
  • events-vertical (Vertical)

mode_switch boolean

Switch mode for small screens.

breakpoint number

Breakpoint.

smallscreen_mode string

Smallscreen mode.

Allowed values:

  • events-horizontal (Horizontal)
  • events-vertical (Vertical)

height_mode string

Height mode. In “Fill space” mode the graphic will fill the container (which by default will be the the standard Flourish responsive chart size). In “Aspect ratio” mode you set the aspect ratio of the plot and the container will be updated to acommodate it (not supported when embedded in a simple fixed-height iframe). "Auto" uses fill space but switches to "Aspect ratio" if there are too many charts for the space.

Allowed values:

  • auto (Auto)
  • fill_space (Fill space)
  • aspect (Aspect ratio)

facet_aspect number

Aspect (desktop). Height of the plot, as % of width

facet_aspect_mobile number

Aspect (mobile). Height of the plot, as % of width

line_color color

Color.

line_width number

Width.

events_layout_type string

Positioning. Determines how labels and events are positioned in the timeline

Allowed values:

  • sequential (Equidistant)
  • chronological-strict (Accurate)

Colors

color.scale_type string

Scale type.

Allowed values:

  • categorical (Categorical)
  • numeric (Numeric)

color.categorical_palette colors

color.categorical_extend boolean

Extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once.

color.categorical_custom_palette text

Custom overrides. Type the name of the entity whose colour you want to set, a colon and then a colour (using a name, hex-code or rgb declaration). Multiple colours can be set using multiple lines. For example:<br /><hr />Party 1: red<br />Party 2: #4455AA<br />Party 3: rgb(30,168,26)

color.numeric_type string

Scale type.

Allowed values:

  • sequential (Sequential)
  • diverging (Diverging)

color.binning boolean

In linear mode, the color scale will run as a smooth gradient between 2 colors. In binned mode, the gradient will be divided in smaller blocks.

Allowed values:

  • false (Linear)
  • true (Binned)

color.bin_mode string

Binning mode.

Allowed values:

  • fixed (Fixed width)
  • quantile (Quantile)
  • custom (Custom thresholds)

color.bin_count number

Number of bins.

color.bin_thresholds string

Custom thresholds. Write your custom thresholds, separated by a ";" For example 5;10;15

color.sequential_palette string

Palette.

Allowed values:

  • Oranges
  • Reds
  • Blues
  • Greens
  • Greys
  • Purples
  • Viridis
  • Inferno
  • Magma
  • Plasma
  • Warm
  • Cool
  • CubehelixDefault (Cubehelix)
  • BuGn (Blue/Green)
  • BuPu (Blue/Purple)
  • GnBu (Green/Blue)
  • OrRd (Orange/Red)
  • PuBuGn (Purple/Blue/Green)
  • PuBu (Purple/Blue)
  • PuRd (Purple/Red)
  • RdPu (Red/Purple)
  • YlGnBu (Yellow/Blue/Green)
  • YlGn (Yellow/Green)
  • YlOrBr (Yellow/Orange/Brown)
  • YlOrRd (Yellow/Orange/Red)
  • Carrots
  • Custom

color.sequential_reverse boolean

Reverse.

color.sequential_custom_min color

Minimum color.

color.sequential_custom_max color

Maximum color.

color.sequential_color_space string

Color space.

Allowed values:

  • rgb (RGB)
  • lab (LAB)
  • hcl (HCL)
  • hsl (HSL)

color.sequential_custom_domain boolean

Domain.

Allowed values:

  • false (Auto)
  • true (Custom)

color.sequential_domain_min number

Min.

color.sequential_domain_max number

Max.

color.diverging_palette string

Palette.

Allowed values:

  • RdBu (Red/Blue)
  • RdYlGn (Red/Yellow/Green)
  • PiYG (Pink/Yellow/Green)
  • BrBG (Brown/Blue/Green)
  • PRGn (Purple/Red/Green)
  • PuOr (Purple/Orange)
  • RdGy (Red/Grey)
  • RdYlBu (Red/Yellow/Blue)
  • Spectral
  • Custom

color.diverging_reverse boolean

Reverse.

color.diverging_custom_min color

Minimum color.

color.diverging_custom_mid color

Midpoint color.

color.diverging_custom_max color

Maximum color.

color.diverging_color_space string

Color space.

Allowed values:

  • rgb (RGB)
  • lab (LAB)
  • hcl (HCL)
  • hsl (HSL)

color.diverging_custom_domain boolean

Domain.

Allowed values:

  • false (Auto)
  • true (Custom)

color.diverging_domain_min number

Min.

color.diverging_domain_mid number

Mid.

color.diverging_domain_max number

Max.

Plots

plot_size number

Size.

plot_background_color color

Fill color. Fallback color (icon color if not determined by template)

plot_border_width number

Border width.

plot_border_color color

Border color. Fallback color (icon color if not determined by template)

label_gap_from_event number

Margin. Sets the area around the plots to keep clear of labels

connector_width number

Width.

connector_color color

Color.

Labels

label_background_color color

Background color.

label_padding number

Padding.

Min: 0.15

Max: 1

label_border_opacity number

Opacity.

Max: 1

label_border_radius number

Radius.

label_border_color color

Color.

label_border_width number

Width.

individual_borders boolean

Style borders individually.

label_border_top_color color

Top.

label_border_top_width number

Width.

label_border_right_color color

Right.

label_border_right_width number

Width.

label_border_bottom_color color

Bottom.

label_border_bottom_width number

Width.

label_border_left_color color

Left.

label_border_left_width number

Width.

label_title_size string

Size.

Allowed values:

  • 0.8 (ᴀ)
  • 1.0 (A)
  • 1.2 (fa-font)
  • custom (...)

label_title_size_custom number

Custom. Specify a custom responsive font size. Best results will be with values between 0.8 and 3

label_title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

label_title_color color

Color.

label_title_line_height number

Line height.

Max: 3

label_title_space_above string

Space above.

Allowed values:

  • 0 (▁)
  • 0.5 (▃)
  • 1 (▄)
  • custom (...)

label_title_space_above_custom number

Custom.

Max: 100

label_subtitle_size string

Size.

Allowed values:

  • 0.8 (ᴀ)
  • 1.0 (A)
  • 1.2 (fa-font)
  • custom (...)

label_subtitle_size_custom number

Custom. Specify a custom responsive font size. Best results will be with values between 0.8 and 3

label_subtitle_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

label_subtitle_color color

Color.

label_subtitle_line_height number

Line height.

Max: 3

label_subtitle_space_above string

Space above.

Allowed values:

  • 0 (▁)
  • 0.5 (▃)
  • 1 (▄)
  • custom (...)

label_subtitle_space_above_custom number

Custom.

Max: 100

label_text_size string

Size.

Allowed values:

  • 0.8 (ᴀ)
  • 1.0 (A)
  • 1.2 (fa-font)
  • custom (...)

label_text_size_custom number

Custom. Specify a custom responsive font size. Best results will be with values between 0.8 and 3

label_text_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

label_text_color color

Color.

label_text_line_height number

Line height.

Max: 3

label_text_space_above string

Space above.

Allowed values:

  • 0 (▁)
  • 0.5 (▃)
  • 1 (▄)
  • custom (...)

label_text_space_above_custom number

Custom.

Max: 100

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

Color.

Underline.

X axis

x.axis_position string

Position.

Allowed values:

  • bottom (Bottom)
  • float-below (Float ↓)
  • float-above (Float ↑)
  • top (Top)
  • off (Hidden)

x.y_axis_position string

Y value. Vertical position of the x axis on the y scale

x.numeric_scale_type string

Type.

Allowed values:

  • linear (Linear)
  • log (Log)

x.linear_min number

Min.

x.linear_max number

Max.

x.log_min number

Min.

x.log_max number

Max.

x.datetime_min string

Min (date).

x.datetime_max string

Max (date).

x.flip boolean

Flip axis.

x.show_scale_settings boolean

Configure default min/max.

x.nice boolean

Round min/max. When enabled, scales automatically extend to "nice" rounded start/end values, such as hundreds or whole years. Overridden by any explicitly specified scale min and max.

Allowed values:

  • true (On)
  • false (Off)

x.zero_axis string

Include zero. Whether to extend the axis to include zero if the data values are all positive or all negative. Overridden by any explicitly specified scale min and max.

Allowed values:

  • auto (Auto)
  • on (On)
  • off (Off)

x.title_mode string

Type.

Allowed values:

  • auto (Auto)
  • custom (Custom)

x.title string

Text.

x.title_styling boolean

Styling.

x.title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

x.title_color color

Color.

x.title_size number

Size.

x.title_padding number

Padding.

x.tick_label_position string

Position.

Allowed values:

  • default (Default)
  • left (Left)
  • right (Right)

x.tick_label_styling boolean

Styling.

x.tick_label_size number

Size.

x.tick_label_color color

Color.

x.tick_padding number

Padding.

x.tick_label_angle string

Angle.

Allowed values:

  • 0 (0°)
  • 30 (30°)
  • 45 (45°)
  • 60 (60°)
  • 90 (90°)

x.tick_label_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

x.tick_label_max_lines number

Max lines.

Min: 1

x.tick_label_line_height number

Line height.

x.tick_label_space_mode string

Space mode.

Allowed values:

  • auto (Auto)
  • max (Max)
  • fixed (Fixed)

x.tick_label_space number

Space.

x.tick_mode string

Mode.

Allowed values:

  • auto (Auto)
  • number (Number)
  • custom (Custom)

x.tick_number number

Number. Approximate number of ticks or gridlines. The actual number will depend on the range of values, chart size, etc.

x.tick_custom text

One tick label per line. Specify the ticks to show, one per line

x.line_and_tick_color color

Line color.

x.line_and_tick_width number

Line width.

x.tick_length number

Tick length.

x.tick_side string

Tick side.

Allowed values:

  • out (Out)
  • in (In)

x.line_visible boolean

Axis line.

x.edge_padding number

Edge padding (%). Space between start/end of axis line and first/last category tick as a percentage of the spacing between ticks

Max: 100

x.gridlines_visible boolean

Allowed values:

  • true (On)
  • false (Off)

x.gridlines_styling boolean

Styling.

x.gridline_color color

Color.

x.gridline_style string

Style.

Allowed values:

  • solid (Solid)
  • dash (Dashed)
  • dot (Dotted)
  • dot_dash (Dot-dashed)

x.gridline_width number

Width.

x.gridline_category_dividers boolean

Put lines between categories. On a categorical axis this option disables the gridline on each tick and instead adds rules between each category to give a table-like design. Ignored for date and numeric axes.

x.gridline_category_dividers_extend boolean

Extend. Extends the dividers into the axis margins.

Y axis

y.axis_visible boolean

Allowed values:

  • true (Axis visible)
  • false (Axis hidden)

y.numeric_scale_type string

Type.

Allowed values:

  • linear (Linear)
  • log (Log)

y.linear_min number

Min.

y.linear_max number

Max.

y.log_min number

Min.

y.log_max number

Max.

y.datetime_min string

Min (date).

y.datetime_max string

Max (date).

y.flip boolean

Flip axis.

y.show_scale_settings boolean

Configure default min/max.

y.nice boolean

Round min/max. When enabled, scales automatically extend to "nice" rounded start/end values, such as hundreds or whole years. Ignored for cagorical scales, and overridden by any specified min/max.

Allowed values:

  • true (On)
  • false (Off)

y.zero_axis string

Include zero. Whether to extend the axis to include zero if the data values are all positive or all negative. Ignored for date and categorical scales, and overridden by any specified min/max.

Allowed values:

  • auto (Auto)
  • on (On)
  • off (Off)

y.title_mode string

Type.

Allowed values:

  • auto (Auto)
  • custom (Custom)

y.title string

Text.

y.title_styling boolean

Styling.

y.title_position string

Position.

Allowed values:

  • side (Side)
  • end (Top/bottom)

y.title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

y.title_color color

Color.

y.title_size number

Size.

y.title_padding number

Padding.

y.tick_label_position string

Position.

Allowed values:

  • default (Default)
  • above (Above)
  • below (Below)

y.tick_label_styling boolean

Styling.

y.tick_label_size number

Size.

y.tick_label_color color

Color.

y.tick_padding number

Padding.

y.tick_label_angle string

Angle.

Allowed values:

  • 0 (0°)
  • 30 (30°)
  • 45 (45°)
  • 60 (60°)
  • 90 (90°)

y.tick_label_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

y.tick_label_max_lines number

Max lines.

Min: 1

y.tick_label_line_height number

Line height.

y.tick_label_space_mode string

Space mode.

Allowed values:

  • auto (Auto)
  • max (Max)
  • fixed (Fixed)

y.tick_label_space number

Space.

y.tick_mode string

Mode.

Allowed values:

  • auto (Auto)
  • number (Number)
  • custom (Custom)

y.tick_number number

Number. Approximate number of ticks or gridlines. The actual number will depend on the range of values, chart size, etc.

y.tick_custom text

One tick label per line. Specify the ticks to show, one per line

y.line_and_tick_color color

Line color.

y.line_and_tick_width number

Line width.

y.tick_length number

Tick length.

y.tick_side string

Side.

Allowed values:

  • out (Out)
  • in (In)

y.line_visible boolean

Axis line.

y.edge_padding number

Edge padding (%). Space between start/end of axis line and first/last category tick as a percentage of the spacing between ticks

Max: 100

y.gridlines_visible boolean

Allowed values:

  • true (On)
  • false (Off)

y.gridlines_styling boolean

Styling.

y.gridline_color color

Color.

y.gridline_style string

Style.

Allowed values:

  • solid (Solid)
  • dash (Dashed)
  • dot (Dotted)
  • dot_dash (Dot-dashed)

y.gridline_width number

Width.

y.gridline_category_dividers boolean

Put lines between categories. On a categorical axis this option disables the gridline on each tick and instead adds rules between each category to give a table-like design. Ignored for date and numeric axes.

y.gridline_category_dividers_extend boolean

Extend. Extends the dividers into the axis margins

Legend

legend_categorical.show_legend boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

legend_categorical.title_mode string

Title mode.

Allowed values:

  • auto (Auto)
  • custom (Custom)

legend_categorical.title string

Title.

legend_categorical.swatch_width number

Width.

legend_categorical.swatch_height number

Height.

legend_categorical.swatch_radius number

Roundness. The radius of the corners of the swatch (in pixels)

legend_categorical.legend_items_padding number

Padding. Padding between legend items (in rems)

legend_categorical.order_override text

Custom order override. Manually specify the order of legend entries (one entry per line)

legend_categorical.icon_height number

Height. Height of icon (relative to the base font size)

legend_categorical.icon_color color

Color. Fallback color (icon color if not determined by template)

legend_categorical.max_width number

Max width.

legend_categorical.orientation string

Orientation.

Allowed values:

  • horizontal (Horizontal)
  • vertical (Vertical)

Layout

layout.body_font font

Main font. This font will apply to the whole graphic by default, but you can optionally change the font for the title, subtitle, footer, etc in the Header and Footer settings panels.

layout.font_color color

Text color. This color will apply to the whole graphic by default, but you can optionally change the color for individual text elements, in other settings panels.

layout.background_color_enabled boolean

Color.

Allowed values:

  • true (On)
  • false (Off)

layout.background_image_enabled boolean

Image.

Allowed values:

  • true (On)
  • false (Off)

layout.background_color color

Background color.

layout.background_image_src url

Image URL.

layout.background_image_size string

Size.

Allowed values:

  • cover (Fill)
  • contain (Fit)
  • auto (Original)
  • 100% 100% (Stretch)

layout.background_image_position string

Position.

Allowed values:

  • top left (Top left)
  • top center (Top center)
  • top right (Top right)
  • center left (Center left)
  • center center (Center)
  • center right (Center right)
  • bottom left (Bottom left)
  • bottom center (Bottom center)
  • bottom right (Bottom right)

layout.max_width_target string

Maximum width. Apply a maximum width to just the main graphic or everything (main graphic plus header, footer, etc)

Allowed values:

  • none (None)
  • wrapper (Everything)
  • primary (Main graphic)

layout.max_width number

Maximum width. Leave blank to stretch to container width

Min: 50

layout.max_width_align string

Align.

Allowed values:

  • left (fa-align-left)
  • center (fa-align-center)
  • right (fa-align-right)

layout.layout_order string

Layout order.

Allowed values:

  • stack-default (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAANhJREFUSA3tVNEOwiAM7Iy/p2/wkTz6g5gjOVZZEepcjMmWLBTau95ugIh6lpzzLcb4wNpFJaRk9MIahxAyXmD7mC7BC2RlFbliQjFMpJTujOdGs/ECwRoP3rlKoEzNJlz3+CwutK0NLRVt2QhjggA9n2IGEKANMxmt0VVsEfxgzfX7zL3ZiqbXLjcKc8vEORk5/75mMB/7u11uuIpdbtDCc5R3l/s+e+pmHt1foza7Nv6IXOeHiqGk9zWtSk1cN2cPrItnYjZzHZEZYtacxHTiuANSO/xN8AS4uW8Rw1Gu2AAAAABJRU5ErkJggg==)
  • stack-2 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAAMpJREFUSA3tVMsKwyAQNKW/l970Iz32Bw0jjKTrSLUY0oOBsO5rnOwYnTs9W0ppDyG8EcsOkw8uauu9T3jR2+75yJxBnnC4JxMxxlezg0V9VsJsIGz75TfKdlkpg3aPcT8TsPNRMJjZEIf5xaAAahUyE+RtfcZvtFLoFh95aFXxH4hCWpUoTCg7fxqUfB4yEcl/CJlNy5qbfuZA8m8CwJ77q2djSj50lnuAWbOAOQlXxCuRHxcUje2XzfgrYzBpHUXLkmxh181SpnEAB4Vg0DSGhHsAAAAASUVORK5CYII=)
  • stack-3 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAANFJREFUSA3tVEEOwyAMo9O+193gkRz3QSZHMmNRUkGp1guVqkCIHZMAITTfVkrZU0pv+B7NQpCV1vEdxxgLfmB9jEvwBBNzkjXn/HIRDOqzJs0GwS1eEmonAn52RITJaUYScd5KLl0fTQf58HVpIFlXMDPNBVMf2TDXPq7dZM2eelrMQ6uDucG50mlWzG/ooCWDvqENXldn1pcyhpgJWjYcPe5z5ZFrAgoe2LN0f2v1ZYq5UyofuiME99hFXKtUm1c9aoBmeEeRjVIQma6XpVblAwnpZjN/VjqsAAAAAElFTkSuQmCC)
  • stack-4 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAANtJREFUSA3tVNEOwjAI3Iy/p2/tR/bRH6zekmuA1glO45bYZAHKcdDCOk1izbXWC+0zlJzzDVJ5sNGW9qSUKj4QKY8yWvBDUWnoKKVcTzS2yWHiIfeMwm2yIbLbRL3DRJYubi+0bAPCkcvapO3AdFgZvuDuyJZR2i4wSpBBP9ZD7RsOLQ9gD/Y5ZmaA3EEHWY6r3SEwrzDEHLpnlvOXa4/7xttZfhNwyPdKcqLPaz6JlXpr9bNgCfbobw2ch5iY0CQzyCOPR9ya5zleBPNy3LxknAbiv1YxExxH3gEqBW7I4zw3PQAAAABJRU5ErkJggg==)

layout.space_between_sections string

Space between sections.

Allowed values:

  • 0.5 (▁)
  • 1 (▃)
  • 1.5 (▄)
  • custom (...)

layout.space_between_sections_custom number

Custom.

Max: 100

layout.margin_top number

Top.

layout.margin_right number

Right.

layout.margin_bottom number

Bottom.

layout.margin_left number

Left.

layout.border.enabled boolean

Show borders around visualisation.

layout.border.top.width number

Top.

layout.border.top.style string

Style.

Allowed values:

  • solid (Solid)
  • dashed (Dashed)
  • dotted (Dotted)

layout.border.top.color color

Color.

layout.border.right.width number

Right.

layout.border.right.style string

Style.

Allowed values:

  • solid (Solid)
  • dashed (Dashed)
  • dotted (Dotted)

layout.border.right.color color

Color.

layout.border.bottom.width number

Bottom.

layout.border.bottom.style string

Style.

Allowed values:

  • solid (Solid)
  • dashed (Dashed)
  • dotted (Dotted)

layout.border.bottom.color color

Color.

layout.border.left.width number

Left.

layout.border.left.style string

Style.

Allowed values:

  • solid (Solid)
  • dashed (Dashed)
  • dotted (Dotted)

layout.border.left.color color

Color.

layout.header_align string

Alignment.

Allowed values:

  • left (fa-align-left)
  • center (fa-align-center)
  • right (fa-align-right)

layout.title string

layout.title_styling boolean

Change title styles.

layout.title_font font

Title Font.

layout.title_size string

Size.

Allowed values:

  • 1.4 (ᴀ)
  • 1.6 (A)
  • 2 (fa-font)
  • custom (...)

layout.title_size_custom number

Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3

layout.title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.title_color color

Color.

layout.title_line_height number

Line height.

Max: 3

layout.title_space_above string

Space above.

Allowed values:

  • 0 (▁)
  • 0.5 (▃)
  • 1 (▄)
  • custom (...)

layout.title_space_above_custom number

Custom.

Max: 100

layout.subtitle string

layout.subtitle_styling boolean

Change subtitle styles.

layout.subtitle_font font

Subtitle Font.

layout.subtitle_size string

Size.

Allowed values:

  • 1.4 (ᴀ)
  • 1.6 (A)
  • 2 (fa-font)
  • custom (...)

layout.subtitle_size_custom number

Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3

layout.subtitle_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.subtitle_color color

Color.

layout.subtitle_line_height number

Line height.

Max: 3

layout.subtitle_space_above string

Space above.

Allowed values:

  • 0 (▁)
  • 0.5 (▃)
  • 1 (▄)
  • custom (...)

layout.subtitle_space_above_custom number

Custom.

Max: 100

layout.header_text string

layout.header_text_styling boolean

Styling.

layout.header_text_size string

Size.

Allowed values:

  • 1.2 (ᴀ)
  • 1.4 (A)
  • 1.6 (fa-font)
  • custom (...)

layout.header_text_size_custom number

Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3

layout.header_text_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.header_text_color color

Color.

layout.header_text_line_height number

Line height.

Max: 3

layout.header_text_space_above string

Space above.

Allowed values:

  • 0 (▁)
  • 0.5 (▃)
  • 1 (▄)
  • custom (...)

layout.header_text_space_above_custom number

Custom.

Max: 100

layout.header_border string

Allowed values:

  • top (Top)
  • bottom (Bottom)
  • none (None)

layout.header_border_width number

Width.

layout.header_border_color color

Color.

layout.header_border_style string

Style.

Allowed values:

  • solid (Solid)
  • dashed (Dashed)
  • dotted (Dotted)

layout.header_border_space number

Space. Space between border and header text

layout.header_logo_enabled boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

layout.header_logo_src url

URL.

layout.header_logo_height number

Height.

layout.header_logo_align string

Align. Align logo inside header or outer visualisation container

Allowed values:

  • outside (Outside)
  • inside (Inside)

layout.header_logo_position_inside string

Position.

Allowed values:

  • top (Top)
  • left (Left)
  • right (Right)

layout.header_logo_position_outside string

Position.

Allowed values:

  • left (Left)
  • right (Right)

layout.header_logo_margin_top number

Top.

layout.header_logo_margin_right number

Right.

layout.header_logo_margin_bottom number

Bottom.

layout.header_logo_margin_left number

Left.

layout.footer_align string

Alignment.

Allowed values:

  • left (fa-align-left)
  • center (fa-align-center)
  • right (fa-align-right)
  • justify (fa-align-justify)

layout.footer_text_size number

Size.

layout.footer_text_color color

Color.

layout.footer_styling boolean

Advanced footer styles.

layout.footer_font font

Font.

layout.footer_text_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.source_name string

Source name.

layout.source_url string

Source url.

layout.multiple_sources boolean

Multiple sources.

layout.source_name_2 string

Source name.

layout.source_url_2 string

Source url.

layout.source_name_3 string

Source name.

layout.source_url_3 string

Source url.

layout.source_label string

Source label.

layout.footer_note string

Note.

layout.footer_note_secondary string

Note (secondary). The secondary note is placed below the source and primary note

layout.footer_logo_enabled boolean

Image.

Allowed values:

  • true (Enabled)
  • false (Disabled)

layout.footer_logo_src url

Image.

layout.footer_logo_src_light hidden

Image (light version). If provided this version will be used whenever the background colour is dark

Link.

layout.footer_logo_height number

Height.

layout.footer_logo_margin number

Margin.

layout.footer_logo_order string

Position.

Allowed values:

  • left (Left)
  • right (Right)

layout.footer_align_vertical string

V. align.

Allowed values:

  • flex-start (Top)
  • center (Center)
  • flex-end (Bottom)

layout.footer_border string

Allowed values:

  • top (Top)
  • bottom (Bottom)
  • none (None)

layout.footer_border_width number

Width.

layout.footer_border_color color

Color.

layout.footer_border_style string

Style.

Allowed values:

  • solid (Solid)
  • dashed (Dashed)
  • dotted (Dotted)

layout.footer_border_space number

Space. Space between border and footer text

Accessibility

layout.screenreader_hide_primary boolean

Screenreader mode for main visual container. Whether the main visual container is visible to screenreaders. (Text in the header and footer are always available to screenreaders.)

Allowed values:

  • true (Hidden)
  • false (Readable)

layout.screenreader_text_primary text

Screenreader description. A text alternative to the visual content that will only be visible to screenreaders, e.g. “The line chart shows China consistently higher than the other countries since 1990”. Do no replicate your title, since that will also be read by screenreaders.