Timeline

Various types of timeline visualizations

Updated 4 months ago to v1.2.0 by Flourish team

How to use this template

What can this template do?

The Timeline template can help you visualize time series data from the past, present, and future. With the ability to categorize events by color, customize markers and add images, you can create an engaging timeline for your users to delve into.

How to get started

For the Timeline template, you’ll need long format data, where each row represents a single data point and each column represents a variable. We recommend that your data has the following layout:

Start time (Required) End time Category Title Text Image
11 October 1968 22 October 1968 Saturn IB Apollo 7 Crewed by Wally Schirra, Donn F. Eisele and Walter Cunningham, the Apollo 7 mission included first live TV broadcast from American spacecraft. https://public.flourish.studio/uploads/ccc2f492-d02f-4a7d-b262-40974c8277a3.png

Editing your timeline

There are a few different styling options to customize your timeline.

You can set the Orientation of your visualization as either Horizontal or Vertical and you can also choose the Height mode of the visualization:

  • Auto: Sets the height based on the modo, data and width.
  • Standard: Sets the height based on the default Flourish responsive sizing.
  • Aspect ratio: Sets the height based on the aspect of each plot.

For vertical orientation, the Auto mode will take into consideration the number of events and will remove the navigation controls, so the user can freely scroll through the timeline.

You can choose between two spacing modes for your timeline scale:

  • Equally spaced is a good option if there are some very long gaps between events as well as very short ones.
  • Time scale will plot events in proportion to the actual time between them.

Editing the content of your events

You can change also the appearance of the Event marker, Event content and Event image:

  • Event marker: This is the circle signifying the event on the main timeline, along with the connecting lines between the circle and the information about the event on the timeline.
  • Event content: This is the information that displays the events that appear on either the side/top and bottom (depending on the orientation you choose) of the timeline. You can change background colors, alignment and styling of your title, subtitle and text and more.
  • Event image: If you have included images within your datasheet, within these settings you will be able to choose whether your image is in the marker or included within the content. Additionally, there are settings to specify how you want your image to appear depending on which option you choose. If you have bound a column under Background image in the Data tab, you'll be able to adjust the opacity and sizing of your images, which will change as you scroll through your timeline. Please note that for vertical timelines, the background image will only appear if you have selected a Standard height mode.

Change the styling of the Navigation, which is how your users will interact with your visualization. To control the way your timeline loads events you can choose between two modes:

  • Window size: The visualization will take into consideration the screen's aspect ratio and the Proportion number you have selected as default.
  • Events: The timeline can transition between individual events based on the Number input.

You can adjust the styling of the buttons that control the navigation by changing the icons to be Default or Custom, where you can upload your own images. Additionally, adjust the sizing and opacity. You can also add a Gradient which will appear at the top/bottom or both sides depending on the orientation you choose.

Tips

  • If your data isn’t in long format, you can transform it using the unpivoting function.
  • Change the way your date/time is displayed in the template directly from the Data tab.
  • Plan to use several images in your timeline? Upload them directly into the datasheet by following these steps.

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: 1

Template data

There are two different formats in which you can supply data to this template. Which one will be more convenient for you likely depends on the source of your data, as described below.

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. To tell the API how these 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: "1",
    bindings: {
        data: {
            title: "DataHeader4"
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/timeline",
    version: "1",
    bindings: {
        data: {
            time_start: "DataHeader1",
            time_end: "DataHeader2",
            category: "DataHeader3",
            title: "DataHeader4",
            subtitle: "DataHeader5",
            text: "DataHeader6",
            image: "DataHeader7",
            background: "DataHeader8"
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

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: "1",
data: {
    data: [
        {
            title: ...
        },
        ...
    ]
},
...
}

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

{
template: "@flourish/timeline",
version: "1",
data: {
    data: [
        {
            time_start: ...,
            time_end: ...,
            category: ...,
            title: ...,
            subtitle: ...,
            text: ...,
            image: ...,
            background: ...
        },
        ...
    ]
},
...
}

Meanings of the template data keys:

  • data.time_start: time_start
  • data.time_end: Sets the duration of the event in time scale mode
  • data.category: category
  • data.title: Title of the content
  • data.subtitle: Subtitle of the content
  • data.text: Text to display inside the data point
  • data.image: Main image for the event
  • data.background: Background image for the event

Template settings

Options for opts.state.

Timeline

widescreen_orientation string

Orientation.

Allowed values:

  • horizontal (Horizontal)
  • vertical (Vertical)

height_mode string

Height mode. How the graphic's height is determined; ignored when embedded in a fixed-height context such as a simple iframe embed. "Auto" sets the height based on the mode, data and width. "Standard" uses the default Flourish responsive sizing. "Aspect ratio" sets the aspect of each plot.

Allowed values:

  • auto (Auto)
  • standard (Standard)
  • aspect (Aspect ratio)

facet_aspect string

Desktop aspect. Aspect ratio of the visualisation in desktop mode.

Allowed values:

  • 0.75 (▋)
  • 1 (■)
  • 1.5 (▆)
  • custom (Custom)

facet_aspect_custom number

Custom. 1 is square, above 1 is wider, and below 1 is taller

Min: 0.1

facet_aspect_breakpoint number

Breakpoint. The width at which mobile mode ends and desktop begins

facet_aspect_mobile string

Mobile aspect. Aspect of the visualisation in mobile mode.

Allowed values:

  • 0.75 (▋)
  • 1 (■)
  • 1.5 (▆)
  • custom (Custom)

facet_aspect_mobile_custom number

Custom. 1 is square, above 1 is wider, and below 1 is taller

Min: 0.1

line_color color

Color.

line_width number

Width. Specified in rems, a multiple of the base font size.

line_cap string

Cap. The shape used to draw the end points.

Allowed values:

  • butt (Butt)
  • round (Round)
  • square (Square)

events_scale_type string

Allowed values:

  • linear (Equally spaced)
  • timescale (Time scale)

Background

background_opacity number

Opacity.

Max: 1

background_sizing string

Sizing.

Allowed values:

  • contain (Fit)
  • cover (Fill)
  • zoom (Zoom)

background_zoom number

Zoom. Sets what size the image should fill the container as a percentage of the container size

background_gradient_size number

Size.

Max: 20

background_gradient_opacity number

Opacity.

Max: 1

background_gradient_blur number

Blur.

Max: 10

Colors

color.categorical_palette colors

Palette.

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". Bins are created between the domain minimum and the first threshold, between each threshold and between the final threshold and the domain maximum. Therefore for the example "5;10;15" four bins are created. (The domain is the minimum and maximum values of your data.)

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.

Event marker

marker_size number

Size.

Max: 5

marker_background_color string

Color.

Allowed values:

  • data (Data)
  • custom (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAABsklEQVRYhdXZ0W3DIBAG4P+qvtcjZIN6hIzgEdwNOkJG8AgeISO4G3iEjOANrsLFFSEXDA4YfBKRLBPnC9wRQYiZcYR4L8VIRGfjcmTm6a6DGtGcDUALQKHYaOr6YrpKQLKjddmhAM4ryKXVqv/bvpn4F0RUAbh6dm/USxYogAHAh2ffuciSQImoJqJBj5x9rwfwGfC42/yaIPdqo4pHAFVA8UitjV5MFpJNrL4XirwlqXoNGoUPHPUUBiGXik+yPDmwIW0wUybZOvoithOfmQh52oBVud08fW6ikZx08fhiRzMfk0IFVOOZBlc7H5NBBUzrmbOTDzIKdA3pgR2Tj6gvMgZ2N6R+j2s1cGL3RPYrq0Fc6AtI12oQd+ojIKXVoI9aTLGRwTN5BKQXtATkKrQUpBNaEvIptDSkCC0R+QAtFana/2me3oMPxp77i5l7Iur0z54Uld0/YL8eFq6RtEbL1ZKN5N3UWwdWxSEl6KCvv0tCsuM07+HMSIi0OWnF1kOyXZHYCN0dCQF6IqLLciYpRBbkHELVZy8c14Kv9jI/ju/TZxtJHYf5QyzXGX5YAPgF8YOBUwwR8PMAAAAASUVORK5CYII=)

marker_background_color_custom color

marker_border_width number

Size.

Max: 2

marker_border_color string

Color.

Allowed values:

  • data (Data)
  • custom (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAABsklEQVRYhdXZ0W3DIBAG4P+qvtcjZIN6hIzgEdwNOkJG8AgeISO4G3iEjOANrsLFFSEXDA4YfBKRLBPnC9wRQYiZcYR4L8VIRGfjcmTm6a6DGtGcDUALQKHYaOr6YrpKQLKjddmhAM4ryKXVqv/bvpn4F0RUAbh6dm/USxYogAHAh2ffuciSQImoJqJBj5x9rwfwGfC42/yaIPdqo4pHAFVA8UitjV5MFpJNrL4XirwlqXoNGoUPHPUUBiGXik+yPDmwIW0wUybZOvoithOfmQh52oBVud08fW6ikZx08fhiRzMfk0IFVOOZBlc7H5NBBUzrmbOTDzIKdA3pgR2Tj6gvMgZ2N6R+j2s1cGL3RPYrq0Fc6AtI12oQd+ojIKXVoI9aTLGRwTN5BKQXtATkKrQUpBNaEvIptDSkCC0R+QAtFana/2me3oMPxp77i5l7Iur0z54Uld0/YL8eFq6RtEbL1ZKN5N3UWwdWxSEl6KCvv0tCsuM07+HMSIi0OWnF1kOyXZHYCN0dCQF6IqLLciYpRBbkHELVZy8c14Kv9jI/ju/TZxtJHYf5QyzXGX5YAPgF8YOBUwwR8PMAAAAASUVORK5CYII=)

marker_border_color_custom color

connector_size number

Size.

Max: 2

connector_space number

Space. Sets the area around the markers to keep clear of content containers

Max: 10

connector_color color

Color.

connector_opacity number

Opacity.

Max: 1

Event content

content_background_color color

Background.

content_padding number

Padding.

content_space_between number

Space between. Defines the minimum amount of space between each content container

content_consistent_size boolean

Keep sizes consistent.

content_border_radius number

Radius.

individual_borders boolean

Style borders individually.

content_border_width number

Width.

content_border_opacity number

Opacity.

Max: 1

content_border_color string

Color.

Allowed values:

  • data (Data)
  • custom (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAABsklEQVRYhdXZ0W3DIBAG4P+qvtcjZIN6hIzgEdwNOkJG8AgeISO4G3iEjOANrsLFFSEXDA4YfBKRLBPnC9wRQYiZcYR4L8VIRGfjcmTm6a6DGtGcDUALQKHYaOr6YrpKQLKjddmhAM4ryKXVqv/bvpn4F0RUAbh6dm/USxYogAHAh2ffuciSQImoJqJBj5x9rwfwGfC42/yaIPdqo4pHAFVA8UitjV5MFpJNrL4XirwlqXoNGoUPHPUUBiGXik+yPDmwIW0wUybZOvoithOfmQh52oBVud08fW6ikZx08fhiRzMfk0IFVOOZBlc7H5NBBUzrmbOTDzIKdA3pgR2Tj6gvMgZ2N6R+j2s1cGL3RPYrq0Fc6AtI12oQd+ojIKXVoI9aTLGRwTN5BKQXtATkKrQUpBNaEvIptDSkCC0R+QAtFana/2me3oMPxp77i5l7Iur0z54Uld0/YL8eFq6RtEbL1ZKN5N3UWwdWxSEl6KCvv0tCsuM07+HMSIi0OWnF1kOyXZHYCN0dCQF6IqLLciYpRBbkHELVZy8c14Kv9jI/ju/TZxtJHYf5QyzXGX5YAPgF8YOBUwwR8PMAAAAASUVORK5CYII=)

content_border_color_custom color

content_border_top_width number

Width.

content_border_top_opacity number

Opacity.

Max: 1

content_border_top_color string

Color.

Allowed values:

  • data (Data)
  • custom (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAABsklEQVRYhdXZ0W3DIBAG4P+qvtcjZIN6hIzgEdwNOkJG8AgeISO4G3iEjOANrsLFFSEXDA4YfBKRLBPnC9wRQYiZcYR4L8VIRGfjcmTm6a6DGtGcDUALQKHYaOr6YrpKQLKjddmhAM4ryKXVqv/bvpn4F0RUAbh6dm/USxYogAHAh2ffuciSQImoJqJBj5x9rwfwGfC42/yaIPdqo4pHAFVA8UitjV5MFpJNrL4XirwlqXoNGoUPHPUUBiGXik+yPDmwIW0wUybZOvoithOfmQh52oBVud08fW6ikZx08fhiRzMfk0IFVOOZBlc7H5NBBUzrmbOTDzIKdA3pgR2Tj6gvMgZ2N6R+j2s1cGL3RPYrq0Fc6AtI12oQd+ojIKXVoI9aTLGRwTN5BKQXtATkKrQUpBNaEvIptDSkCC0R+QAtFana/2me3oMPxp77i5l7Iur0z54Uld0/YL8eFq6RtEbL1ZKN5N3UWwdWxSEl6KCvv0tCsuM07+HMSIi0OWnF1kOyXZHYCN0dCQF6IqLLciYpRBbkHELVZy8c14Kv9jI/ju/TZxtJHYf5QyzXGX5YAPgF8YOBUwwR8PMAAAAASUVORK5CYII=)

content_border_top_color_custom color

content_border_right_width number

Width.

content_border_right_opacity number

Opacity.

Max: 1

content_border_right_color string

Color.

Allowed values:

  • data (Data)
  • custom (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAABsklEQVRYhdXZ0W3DIBAG4P+qvtcjZIN6hIzgEdwNOkJG8AgeISO4G3iEjOANrsLFFSEXDA4YfBKRLBPnC9wRQYiZcYR4L8VIRGfjcmTm6a6DGtGcDUALQKHYaOr6YrpKQLKjddmhAM4ryKXVqv/bvpn4F0RUAbh6dm/USxYogAHAh2ffuciSQImoJqJBj5x9rwfwGfC42/yaIPdqo4pHAFVA8UitjV5MFpJNrL4XirwlqXoNGoUPHPUUBiGXik+yPDmwIW0wUybZOvoithOfmQh52oBVud08fW6ikZx08fhiRzMfk0IFVOOZBlc7H5NBBUzrmbOTDzIKdA3pgR2Tj6gvMgZ2N6R+j2s1cGL3RPYrq0Fc6AtI12oQd+ojIKXVoI9aTLGRwTN5BKQXtATkKrQUpBNaEvIptDSkCC0R+QAtFana/2me3oMPxp77i5l7Iur0z54Uld0/YL8eFq6RtEbL1ZKN5N3UWwdWxSEl6KCvv0tCsuM07+HMSIi0OWnF1kOyXZHYCN0dCQF6IqLLciYpRBbkHELVZy8c14Kv9jI/ju/TZxtJHYf5QyzXGX5YAPgF8YOBUwwR8PMAAAAASUVORK5CYII=)

content_border_right_color_custom color

content_border_bottom_width number

Width.

content_border_bottom_opacity number

Opacity.

Max: 1

content_border_bottom_color string

Color.

Allowed values:

  • data (Data)
  • custom (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAABsklEQVRYhdXZ0W3DIBAG4P+qvtcjZIN6hIzgEdwNOkJG8AgeISO4G3iEjOANrsLFFSEXDA4YfBKRLBPnC9wRQYiZcYR4L8VIRGfjcmTm6a6DGtGcDUALQKHYaOr6YrpKQLKjddmhAM4ryKXVqv/bvpn4F0RUAbh6dm/USxYogAHAh2ffuciSQImoJqJBj5x9rwfwGfC42/yaIPdqo4pHAFVA8UitjV5MFpJNrL4XirwlqXoNGoUPHPUUBiGXik+yPDmwIW0wUybZOvoithOfmQh52oBVud08fW6ikZx08fhiRzMfk0IFVOOZBlc7H5NBBUzrmbOTDzIKdA3pgR2Tj6gvMgZ2N6R+j2s1cGL3RPYrq0Fc6AtI12oQd+ojIKXVoI9aTLGRwTN5BKQXtATkKrQUpBNaEvIptDSkCC0R+QAtFana/2me3oMPxp77i5l7Iur0z54Uld0/YL8eFq6RtEbL1ZKN5N3UWwdWxSEl6KCvv0tCsuM07+HMSIi0OWnF1kOyXZHYCN0dCQF6IqLLciYpRBbkHELVZy8c14Kv9jI/ju/TZxtJHYf5QyzXGX5YAPgF8YOBUwwR8PMAAAAASUVORK5CYII=)

content_border_bottom_color_custom color

content_border_left_width number

Width.

content_border_left_opacity number

Opacity.

Max: 1

content_border_left_color string

Color.

Allowed values:

  • data (Data)
  • custom (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAABsklEQVRYhdXZ0W3DIBAG4P+qvtcjZIN6hIzgEdwNOkJG8AgeISO4G3iEjOANrsLFFSEXDA4YfBKRLBPnC9wRQYiZcYR4L8VIRGfjcmTm6a6DGtGcDUALQKHYaOr6YrpKQLKjddmhAM4ryKXVqv/bvpn4F0RUAbh6dm/USxYogAHAh2ffuciSQImoJqJBj5x9rwfwGfC42/yaIPdqo4pHAFVA8UitjV5MFpJNrL4XirwlqXoNGoUPHPUUBiGXik+yPDmwIW0wUybZOvoithOfmQh52oBVud08fW6ikZx08fhiRzMfk0IFVOOZBlc7H5NBBUzrmbOTDzIKdA3pgR2Tj6gvMgZ2N6R+j2s1cGL3RPYrq0Fc6AtI12oQd+ojIKXVoI9aTLGRwTN5BKQXtATkKrQUpBNaEvIptDSkCC0R+QAtFana/2me3oMPxp77i5l7Iur0z54Uld0/YL8eFq6RtEbL1ZKN5N3UWwdWxSEl6KCvv0tCsuM07+HMSIi0OWnF1kOyXZHYCN0dCQF6IqLLciYpRBbkHELVZy8c14Kv9jI/ju/TZxtJHYf5QyzXGX5YAPgF8YOBUwwR8PMAAAAASUVORK5CYII=)

content_border_left_color_custom color

content_title_alignment string

Alignment.

Allowed values:

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

content_title_styling boolean

Styling.

content_title_line_height number

Line height.

Max: 3

content_title_size string

Size.

Allowed values:

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

content_title_size_custom number

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

content_title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

content_title_color string

Color.

Allowed values:

  • data (Data)
  • custom (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAABsklEQVRYhdXZ0W3DIBAG4P+qvtcjZIN6hIzgEdwNOkJG8AgeISO4G3iEjOANrsLFFSEXDA4YfBKRLBPnC9wRQYiZcYR4L8VIRGfjcmTm6a6DGtGcDUALQKHYaOr6YrpKQLKjddmhAM4ryKXVqv/bvpn4F0RUAbh6dm/USxYogAHAh2ffuciSQImoJqJBj5x9rwfwGfC42/yaIPdqo4pHAFVA8UitjV5MFpJNrL4XirwlqXoNGoUPHPUUBiGXik+yPDmwIW0wUybZOvoithOfmQh52oBVud08fW6ikZx08fhiRzMfk0IFVOOZBlc7H5NBBUzrmbOTDzIKdA3pgR2Tj6gvMgZ2N6R+j2s1cGL3RPYrq0Fc6AtI12oQd+ojIKXVoI9aTLGRwTN5BKQXtATkKrQUpBNaEvIptDSkCC0R+QAtFana/2me3oMPxp77i5l7Iur0z54Uld0/YL8eFq6RtEbL1ZKN5N3UWwdWxSEl6KCvv0tCsuM07+HMSIi0OWnF1kOyXZHYCN0dCQF6IqLLciYpRBbkHELVZy8c14Kv9jI/ju/TZxtJHYf5QyzXGX5YAPgF8YOBUwwR8PMAAAAASUVORK5CYII=)

content_title_color_custom color

content_title_space_above string

Space above.

Allowed values:

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

content_title_space_above_custom number

Custom.

Max: 100

content_subtitle_alignment string

Alignment.

Allowed values:

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

content_subtitle_styling boolean

Styling.

content_subtitle_line_height number

Line height.

Max: 3

content_subtitle_size string

Size.

Allowed values:

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

content_subtitle_size_custom number

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

content_subtitle_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

content_subtitle_color string

Color.

Allowed values:

  • data (Data)
  • custom (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAABsklEQVRYhdXZ0W3DIBAG4P+qvtcjZIN6hIzgEdwNOkJG8AgeISO4G3iEjOANrsLFFSEXDA4YfBKRLBPnC9wRQYiZcYR4L8VIRGfjcmTm6a6DGtGcDUALQKHYaOr6YrpKQLKjddmhAM4ryKXVqv/bvpn4F0RUAbh6dm/USxYogAHAh2ffuciSQImoJqJBj5x9rwfwGfC42/yaIPdqo4pHAFVA8UitjV5MFpJNrL4XirwlqXoNGoUPHPUUBiGXik+yPDmwIW0wUybZOvoithOfmQh52oBVud08fW6ikZx08fhiRzMfk0IFVOOZBlc7H5NBBUzrmbOTDzIKdA3pgR2Tj6gvMgZ2N6R+j2s1cGL3RPYrq0Fc6AtI12oQd+ojIKXVoI9aTLGRwTN5BKQXtATkKrQUpBNaEvIptDSkCC0R+QAtFana/2me3oMPxp77i5l7Iur0z54Uld0/YL8eFq6RtEbL1ZKN5N3UWwdWxSEl6KCvv0tCsuM07+HMSIi0OWnF1kOyXZHYCN0dCQF6IqLLciYpRBbkHELVZy8c14Kv9jI/ju/TZxtJHYf5QyzXGX5YAPgF8YOBUwwR8PMAAAAASUVORK5CYII=)

content_subtitle_color_custom color

content_subtitle_space_above string

Space above.

Allowed values:

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

content_subtitle_space_above_custom number

Custom.

Max: 100

content_text_alignment string

Alignment.

Allowed values:

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

content_text_styling boolean

Styling.

content_text_line_height number

Line height.

Max: 3

content_text_size string

Size.

Allowed values:

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

content_text_size_custom number

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

content_text_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

content_text_color string

Color.

Allowed values:

  • data (Data)
  • custom (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAABsklEQVRYhdXZ0W3DIBAG4P+qvtcjZIN6hIzgEdwNOkJG8AgeISO4G3iEjOANrsLFFSEXDA4YfBKRLBPnC9wRQYiZcYR4L8VIRGfjcmTm6a6DGtGcDUALQKHYaOr6YrpKQLKjddmhAM4ryKXVqv/bvpn4F0RUAbh6dm/USxYogAHAh2ffuciSQImoJqJBj5x9rwfwGfC42/yaIPdqo4pHAFVA8UitjV5MFpJNrL4XirwlqXoNGoUPHPUUBiGXik+yPDmwIW0wUybZOvoithOfmQh52oBVud08fW6ikZx08fhiRzMfk0IFVOOZBlc7H5NBBUzrmbOTDzIKdA3pgR2Tj6gvMgZ2N6R+j2s1cGL3RPYrq0Fc6AtI12oQd+ojIKXVoI9aTLGRwTN5BKQXtATkKrQUpBNaEvIptDSkCC0R+QAtFana/2me3oMPxp77i5l7Iur0z54Uld0/YL8eFq6RtEbL1ZKN5N3UWwdWxSEl6KCvv0tCsuM07+HMSIi0OWnF1kOyXZHYCN0dCQF6IqLLciYpRBbkHELVZy8c14Kv9jI/ju/TZxtJHYf5QyzXGX5YAPgF8YOBUwwR8PMAAAAASUVORK5CYII=)

content_text_color_custom color

content_text_space_above string

Space above.

Allowed values:

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

content_text_space_above_custom number

Custom.

Max: 100

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

Color.

Underline.

Event image

image_location string

Location.

Allowed values:

  • none (None)
  • marker (Marker)
  • content (Content)

image_opacity number

Opacity.

Max: 1

image_display string

Content display.

Allowed values:

  • float (Float)
  • inline (Inline)
  • banner (Banner)
  • background (Background)

image_sizing string

Sizing.

Allowed values:

  • contain (Fit)
  • cover (Fill)
  • zoom (Zoom)

image_zoom number

Zoom. Sets what size the image should fill the container as a percentage of the container size

image_content_sizing string

Sizing.

Allowed values:

  • contain (Fit)
  • cover (Fill)
  • zoom (Zoom)

image_content_zoom number

Zoom. Sets what size the image should fill the container as a percentage of the container size

image_float_position string

Position.

Allowed values:

  • 1 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAACuc5z4AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAABcSURBVHgB7dJBCsAgDAXRWHr/IzcFUVARGcGASt6qi4HKVxHnWqH4VtCNmqp9xMgrcwINtzkx3vi8KfAJEvIkbc3+hfRKw9IHGrN7i1ZOoTTsGU1hO0Hmr8Ld4AemVAodg7AaJAAAAABJRU5ErkJggg==)
  • 2 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAACuc5z4AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAABcSURBVHgB7ZJLCgAgCEQtuv+Rq1UQfUfKovCtXMiUT4kUpcRkdWD0h1mPJSFc+dIujvyY45gV/IYK9Ny2TrOE6dQ9kAVXYR7oF9sJDKoCVtAKG6m4ryChV6H8QAS+qwod9FzVFQAAAABJRU5ErkJggg==)

image_inline_position string

Position.

Allowed values:

  • 1 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAACuc5z4AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAABMSURBVHgB7dNBCgAgCETRKbr/kbNtBJKhBsK8lYv4C0mA6NS2WYzvTDqSMFw4XI/1QF5bGIHhP5oye8gZm4iR+4UjVyFa2LsKXjFdLI06BxZ3bmMOAAAAAElFTkSuQmCC)
  • 2 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAACuc5z4AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAABPSURBVHgB7dQxDgAgCAPAYvz/k8XFgZgQNYBTb+rUoQkARDsxWRFju9BAy+3GgkdlG7O4vribHL28P8TJEbqXDeSo/T+ZU6hXHJ2CL5gOJkGnBxaj8/VKAAAAAElFTkSuQmCC)
  • 3 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAACuc5z4AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAABLSURBVHgB7dQxCgAgDAPAKP7/y7o4lGLBYjMIuSlToEULiHjN5Ik3tgsdslXu+NT5Edpzo2lB9tLT3K4iPSbt56mYXzxMrroVIoEF+hQGFUuDEAkAAAAASUVORK5CYII=)

image_alignment string

Alignment.

Allowed values:

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

content_banner_depth string

Banner depth.

Allowed values:

  • 2 (▃)
  • 4 (▆)
  • 6 (▉)
  • custom (...)

content_banner_depth_custom number

Custom.

Max: 10

image_width number

Width. Sets what size of the image in rems

image_margin number

Margin.

image_aspect number

Aspect ratio. As a multiplier of the image's width. For example: a value of 2, means the image height is 2 times the image width

Min: 0.1

Max: 2

Step by. Determines by which measure the timeline is approximately moved each time the navigation buttons are clicked.

Allowed values:

  • screen (Window size)
  • event (Events)

Proportion.

Min: 0.1

Max: 1

Number.

Min: 1

Max: 5

Icon.

Allowed values:

  • default (Default)
  • custom (Custom)

Size.

Opacity.

Max: 1

Custom icon.

Color.

Color. If undefined the color will default to the background of the visualisation

Width.

Opacity.

Max: 1

Axis

x.axis_position string

Position.

Allowed values:

  • bottom (Bottom)
  • top (Top)
  • hidden (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.

x.gridline_category_dividers_extend boolean

Extend. Extends the dividers into the axis margins.

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.

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.

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.read_direction string

Read direction. This will change the reading direction of the main text elements on the page. Its not possible to adjust this on all elements such as axes. Note that when direction is set to "right to left" any alignment icons will be reversed.

Allowed values:

  • ltr (Left to right)
  • rtl (Right to left)

layout.header_align string

Alignment.

Allowed values:

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

layout.title html

layout.title_styling boolean

Styling.

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 html

layout.subtitle_styling boolean

Styling.

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 html

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)
  • top_and_bottom (Top & 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

Image.

Link.

layout.header_logo_height number

Height.

layout.header_logo_align string

Align. Align logo inside either the header or the main visualisation container

Allowed values:

  • inside (Header)
  • outside (Main container)

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)
  • top_and_bottom (Top & 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 not replicate your title, since that will also be read by screenreaders.

layout.screenreader_label string

Screenreader label. A short text label given to the main Flourish embed wrapper to provide an accessible name that is only visible to screenreaders. Added in the form of an "aria-label".