Heatmap

Reveal patterns across one or two dimensions

Updated a day ago to v3.10.3 by Flourish team

How to use this template

What’s it for?

Heatmaps are great for revealing patterns in a variable across one dimension (like the famous Climate Stripes visualization or two (a more traditional “grid” heatmap).

2D heatmaps are often used for comparing distributions across multiple categories, places or time periods, but they can also be used for visualizing correlations across two numeric axes – like a scatter plot but with the data points grouped into ”bins”.

How to get started

Upload a CSV or Excel file with one column to shade by (this would typically be a numeric column) plus one or two columns of categories or numbers for the axes. Dates are treated as categories so if you have time in your data sheet be sure that each row represents the same time interval!

Data for a simple 1D heatmap might be something like this:

Year Temperature difference
1880 -0.19
1881 -0.1
1882 -0.11
1883 -0.19

A 2D heatmap adds an extra dimension. For example:

Year Mean temperature Region
1884 9.87 Southeast and Central England
1885 8.8 Southeast and Central England
1886 9.72 South England
1887 8.61 South England

Not sure how to upload your data to Flourish? See our handy guide

Instructions

Once you've uploaded your data and selected your columns, be sure to select whether each dimension is categorical or numerical in the "Heatmap" settings panel.

Credits

Example data shows annual mean temperature data for UK regions, from the Met Office National Climate Information Centre.

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/heatmap

version: 3

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/heatmap",
    version: "3",
    bindings: {
        data: {
            
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@flourish/heatmap",
    version: "3",
    bindings: {
        data: {
            x: 0, // index of a column in your data
            y: 1, // index of a column in your data
            value: 2, // index of a column in your data
            filter: 3, // index of a column in your data
            metadata: [4, 5, ...], // index(es) of column(s) 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/heatmap",
    version: "3",
    bindings: {
        data: {
            
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/heatmap",
    version: "3",
    bindings: {
        data: {
            x: "DataHeader1",
            y: "DataHeader2",
            value: "DataHeader3",
            filter: "DataHeader4",
            metadata: ["DataHeader5", "DataHeader6", ...],
        }
    },
    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/heatmap",
    version: "3",
    data: {
    data: [
        {
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/heatmap",
    version: "3",
    data: {
    data: [
        {
            x: ...,
            y: ...,
            value: ...,
            filter: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

  • data.x: x
  • data.y: y
  • data.value: value
  • data.filter: filter
  • data.metadata: One or more columns of information to be included in popups and panels. When multiple rows are aggregated into one heatmap cell, only the popup content of the first row will be shown.

Template settings

Options for opts.state.

Heatmap

x_axis_datatype string

Data type.

Allowed values:

  • numeric (Numbers)
  • categorical (Categories)

x_axis_binning string

Binning mode.

Allowed values:

  • auto (Auto)
  • custom (Custom)

x_axis_bin_width number

Bin width. The numeric range of each bin – e.g. a bin width of 10 would give bins of 0–10, 10–20, etc (assuming a bin center of 5).

x_axis_bin_center number

Bin center. One value you'd like as the center of a bin – e.g. with a bin width of 10, a center of 5 would give 0–10, 10–20, 20–30, etc, while a center of 0 would give -5–5, 5–10, 10–20, etc.

cell_x_margin number

Cell padding.

y_axis_datatype string

Data type.

Allowed values:

  • numeric (Numbers)
  • categorical (Categories)

y_axis_binning string

Binning mode.

Allowed values:

  • auto (Auto)
  • custom (Custom)

y_axis_bin_width number

Bin width. The numeric range of each bin – e.g. a bin width of 10 would give bins of 0–10, 10–20, etc (assuming a bin center of 5).

y_axis_bin_center number

Bin center. One value you'd like as the center of a bin – e.g. with a bin width of 10, a center of 5 would give 0–10, 10–20, 20–30, etc, while a center of 0 would give -5–5, 5–10, 10–20, etc.

cell_y_margin number

Cell padding.

height_mode string

Height mode. Apsect ratio and fixed modes only work when embedding responsively with a script embed

Allowed values:

  • auto (Fill space)
  • fixed (Cell height)
  • aspect (Cell aspect)

cell_height number

Height. Height of each cell in rems (multiple of base font size)

cell_aspect number

Aspect. Aspect ratio (width/height) of each cell

Colors

scale_type string

Scale type.

Allowed values:

  • categorical (Categorical)
  • numeric (Numeric)

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. Enter the label name for which you wish to set the color, followed by a colon and the desired color value.

Colors can be set using Hex, RGB, color names or RGBA, if you want to set the opacity. Multiple colors can be set using multiple lines. For example:


Party 1: red
Party 2: #4455AA
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. Enter your desired thresholds, separating them with a ";". For instance, "5;10;15".

Bins form as follows:

  • From the data's minimum value (domain minimum) up to the first threshold.
  • Between consecutive thresholds.
  • From the last threshold to the data's maximum value (domain maximum).

    • For "5;10;15", you'll get four bins based on your data's range.

      color.sequential_palette string

      Palette.

      Allowed values:

      • Oranges (Oranges)
      • Reds (Reds)
      • Blues (Blues)
      • Greens (Greens)
      • Greys (Greys)
      • Purples (Purples)
      • Viridis (Viridis)
      • Inferno (Inferno)
      • Magma (Magma)
      • Plasma (Plasma)
      • Warm (Warm)
      • Cool (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 (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.

      Legend

      legend_continuous.show_legend boolean

      Allowed values:

      • true (Enabled)
      • false (Disabled)

      legend_continuous.title_mode string

      Title mode.

      Allowed values:

      • auto (Auto)
      • custom (Custom)

      legend_continuous.title string

      Title.

      legend_continuous.color_band_width number

      Width.

      legend_continuous.color_band_height number

      Height.

      legend_continuous.color_band_radius number

      Roundness. The radius of the corners of the color band (in pixels)

      legend_continuous.binned_label_mode string

      Binned label mode.

      Allowed values:

      • thresholds (Thresholds)
      • centers (Centers)
      • custom (Custom)

      legend_continuous.binned_label_custom string

      Custom bin labels. List numeric values, separated by semi-colons.

      legend_continuous.legend_min number

      Legend min.

      legend_continuous.additional_min_label string

      Custom min label.

      legend_continuous.legend_max number

      Legend max.

      legend_continuous.additional_max_label string

      Custom max label.

      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.swatch_outline boolean

      Outline. An optional outline for the swatch in the legend

      legend_categorical.swatch_outline_color color

      Color.

      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 (in rems)

      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)

      legend_container.alignment string

      Alignment.

      Allowed values:

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

      legend_container.orientation string

      Orientation.

      Allowed values:

      • horizontal (Horizontal)
      • vertical (Vertical)

      legend_container.title_weight string

      Title weight.

      Allowed values:

      • bold (Bold)
      • normal (Normal)

      legend_container.text_weight string

      Text weight.

      Allowed values:

      • bold (Bold)
      • normal (Normal)

      legend_container.text_color color

      Color.

      legend_container.text_size number

      Size.

      Max: 10

      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. Enabling this option rounds the X axis start and end values to <a href="https://help.flourish.studio/article/224-how-to-avoid-gaps-between-axes-and-series>tidy numbers, such as 0, 50, 100 or whole years. Specified min and max values will override this feature.

      Allowed values:

      • true (On)
      • false (Off)

      x.zero_axis string

      Include zero. Enable to extend the axis to include zero, even when data is all positive or all negative. This is ignored if you set specific min and max scale values.

      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. Sets the method for selecting tick values on the axis:

      Auto automatically selects the ticks
      Number allows you to choose the number of ticks to display.
      Custom lets you select specific ticks to show.

      Note: If the axis is categorical, Number mode is ignored.

      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. For dates, use the input format as specified in the datasheet.

      You can also use {{FIRST}} and {{LAST}} to add ticks at the minimum and maximum of the axis. For example:

      {{FIRST}}
      25000
      50000
      75000
      {{LAST}}

      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

      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. Sets the method for selecting tick values on the axis:

      Auto automatically selects the ticks
      Number allows you to choose the number of ticks to display.
      Custom lets you select specific ticks to show.

      Note: If the axis is categorical, Number mode is ignored.

      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. For dates, use the input format as specified in the datasheet.

      You can also use {{FIRST}} and {{LAST}} to add ticks at the minimum and maximum of the axis. For example:

      {{FIRST}}
      25000
      50000
      75000
      {{LAST}}

      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

      Annotations

      axes_highlights.x_enabled boolean

      Show highlights on the x axis.

      axes_highlights.x_lines text

      One per line, in format “My label :: 2012”. One per line, using the format:

       My label :: 2012 
      For dates, use the input format as specified in the datasheet. You can optionally specify a line color and a text color. For visualizations using a grid of charts, you can apply the annotation only on a specific chart. Use the format:
       My label :: 2012 :: line_color / text_color :: facet_name 
      For example,
       My label :: 2012 :: #eb0000 / #0084bd :: Category 1
      If you want to add an annotation to just one specific chart but do not want to color the line/text, you can leave that part blank. For example:
       My label :: 2012 ::  :: Category 1 

      axes_highlights.x_line_color color

      Line color.

      axes_highlights.x_line_width number

      Line width.

      axes_highlights.x_line_dash number

      Dash.

      axes_highlights.x_areas text

      One per line, in format “My label :: 2013 >> 2015”. One per line, using the format:

       My label :: date >> date 
      For dates, use the input format as specified in the datasheet. You can optionally specify a line color and a text color. For visualizations using a grid of charts, you can apply the annotation only on a specific chart. Use the format:
       My label :: 2012 :: area_color / text_color :: facet_name
      For example,
       My label :: 2012 >> 2015 :: #eb0000 / #0084bd :: Category 1 

      axes_highlights.x_area_color color

      Area.

      axes_highlights.x_area_opacity number

      Area opacity.

      axes_highlights.x_area_texture string

      Area texture.

      Allowed values:

      • none (fa-stop)
      • fl-pattern-diagonal (fa-bars)
      • fl-pattern-grid (fa-th)
      • fl-pattern-dots (fa-circle-o)

      axes_highlights.x_label_vertical boolean

      Vertical.

      axes_highlights.x_label_y_position string

      Y position. Vertically position the label at the top, bottom or in the middle of the line. This setting will be ignored if there is not enough space for the selected position

      Allowed values:

      • bottom (fa-arrow-down)
      • middle (fa-minus)
      • top (fa-arrow-up)

      axes_highlights.x_label_x_position string

      X position. Horizontally position the label on the left, the right or in the middle of the line. This setting will be ignored if there is not enough space for the selected position

      Allowed values:

      • left (fa-arrow-left)
      • middle (fa-minus)
      • right (fa-arrow-right)

      axes_highlights.x_label_max_width number

      Max width.

      Min: 1

      axes_highlights.x_font_size number

      Font size.

      axes_highlights.x_font_weight string

      Font weight.

      Allowed values:

      • regular (Regular)
      • bold (Bold)

      axes_highlights.x_label_color color

      Text.

      axes_highlights.x_shadow_color color

      Shadow.

      axes_highlights.x_shadow_enabled boolean

      Shadow.

      axes_highlights.y_enabled boolean

      Show highlights on the y axis.

      axes_highlights.y_lines text

      One per line, in format “My label :: 5000”. One per line, using the format:

       My label :: 2012 
      For dates, use the input format as specified in the datasheet. You can optionally specify a line color and a text color. For visualizations using a grid of charts, you can apply the annotation only on a specific chart. Use the format:
       My label :: 2012 :: line_color / text_color :: facet_name 
      For example:
       My label :: 2012 :: #eb0000 / #0084bd :: Category 1 
      If you want to add an annotation to just one specific chart but do not want to color the line/text, you can leave that part blank. For example:
       My label :: 2012 ::  :: Category 1 

      axes_highlights.y_line_color color

      Line color.

      axes_highlights.y_line_width number

      line width.

      axes_highlights.y_line_dash number

      Dash.

      axes_highlights.y_areas text

      One per line, in format “My label :: 2000 >> 8000”. One per line, using the format:

       My label :: date >> date 
      For dates, use the input format as specified in the datasheet. You can optionally specify a line color and a text color. For visualizations using a grid of charts, you can apply the annotation only on a specific chart. Use the format:
       My label :: 2012 :: area_color / text_color :: facet_name 
      For example:
       My label :: 2012 >> 2015 :: #eb0000 / #0084bd :: Category 1 

      axes_highlights.y_area_color color

      Area.

      axes_highlights.y_area_opacity number

      Area opacity.

      axes_highlights.y_area_texture string

      Area texture.

      Allowed values:

      • none (fa-stop)
      • fl-pattern-diagonal (fa-bars)
      • fl-pattern-grid (fa-th)
      • fl-pattern-dots (fa-circle-o)

      axes_highlights.y_label_x_position string

      X position. Horizontally position label on the left, the middle or the right end of the line. This setting will be ignored if there is not enough space for the selected position

      Allowed values:

      • left (fa-arrow-left)
      • middle (fa-minus)
      • right (fa-arrow-right)

      axes_highlights.y_label_y_position string

      Y position. Vertically position the label above, below or in the middle of the line. This setting will be ignored if there is not enough space for the selected position

      Allowed values:

      • above (fa-arrow-up)
      • middle (fa-minus)
      • below (fa-arrow-down)

      axes_highlights.y_label_max_width number

      Max width.

      Min: 1

      axes_highlights.y_font_size number

      Font size.

      axes_highlights.y_font_weight string

      Font weight.

      Allowed values:

      • regular (Regular)
      • bold (Bold)

      axes_highlights.y_label_color color

      Text.

      axes_highlights.y_shadow_color color

      Shadow.

      axes_highlights.y_shadow_enabled boolean

      Shadow.

      Animation

      animation_style string

      Allowed values:

      • none (None)
      • fade (Fade)
      • flip (Flip)

      animation_duration number

      Animation duration. The duration it takes each cell to transition, in seconds

      animation_spread number

      Animation spread. The number of seconds over which the cell animations begin. Leave blank for a special spread that depends on the number of cells.

      animation_key boolean

      Only animate cells with same x and y value.

      Controls

      row_filter_all boolean

      Include “All”.

      row_filter_all_text string

      “All” text.

      row_filter.control_type string

      Control type. Choose between a dropdown, buttons or a time slider.

      Allowed values:

      • dropdown (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAC0AAAAKCAYAAAFXtOeCAAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAALaADAAQAAAABAAAACgAAAAAWgdR+AAAAtklEQVQ4EdVV3QnEIAw25TbSB2foNI7iMu0MbuUR4ZOQy4OFCL2AmN8vMQallNLVez+DosNSsg/FGLtyDkR0H1rJMqOMiJxz4KWp1jpUsLNsptCBkD/MlFIgzx3IsD9GflTGTLvImN1ajP1x043dVrlr1fIY4xZZYd2kdATfWgu8NCEedtdWcJ+R1BVYnmIbsEzizW8bDO9CJd4cOijxCEH22DGIq1iyBiv2P8eDP4jVDrzE7/oCOyRFCckULykAAAAASUVORK5CYII=)
      • buttons (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAAKCAYAAAFaqpfFAAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAK6ADAAQAAAABAAAACgAAAACxtWN2AAAA5klEQVQ4EdVUwQ2DMAwkqBuFBzO0y2QUlqEz5AEzpTrUiyzLEEPbRy2F2D7n4tgWYRiGuZRy75T0lhMxIcZYoKzrWvUeDi0VTSlt2DRN9dQ4jh0WBP4avHneH3kF/SGE5w0GWXPOHRaFfrDiEW5mEJjBZJY7UoPNakjM0s0KWYFnfa6MUbRlWR573daXurLlhHDXJNreugan7D2D0K09YUeJy467no+D1iyRUO+u5+tDLdudaYuIOEcQtncMeba1/6QCrUuv4nWwJIE1ZBKHLgdJY0f2J9z/NQb4cRxV4iQ2y/hvc78ACNVvxtjAMtcAAAAASUVORK5CYII=)
      • slider (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACkAAAAKCAYAAAFeX0f4AAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAKaADAAQAAAABAAAACgAAAABlifOxAAABz0lEQVQ4Ea1UvU7CUBSml05EHoBEB3gFGpg0fQE0Tk6suDC4uKBuxsXJ6BswGZaq0bnRqaR9CglPwEJCW79Dem5Of2iq8Sbk/H/349zTU7Msy6nhdLvdJUk+Ko7jk8RosbNcAupKZhjAjMkRBIHWG41GbTQayTzSP1IOIL32er3DlDMxTEI1DGPh+/4BSA7CMBxMp9N8LlAu2EtF+IVsS6m5maZpeZ4XcDApUGzX6/Wj+Xz+xXaZ1EWg59m2vSeSdYx8URRdili52u/394syqFlgu6TGFcV3+dRms/lGoS8TCAysP+FrUYN39U3WsG4mCmq2b3+Kt3cA9swJiVR4se1sZPw5kwEp8EBgpOD5fWJGOp/hcGiwXiap+atOp2MCTI8HZukY/ogLcUFqlNlfJHl8Vii6abfbj7PZrHDOuBiPNAH7W9hZxhFhgMwd5/6XZJIaDxeFIPHUbDavXddd6QAUmqJse2WcdNS/JV3Lhv5s50gyEi5bQB/jwhf2YcBoYZXuph3LhiF+LcHjXQ4kAQTYGudya0hUbIwzTL8LX+qjFznRer22MbyVtoqoK1UNPKGDy8cgRp2rdOi7p22Ep7eoAP/WV0rdV115lS4RST+YjrA2q0ehBQAAAABJRU5ErkJggg==)

      row_filter.control_styles boolean

      Adv..

      row_filter.control_title string

      Control title.

      row_filter.button_group boolean

      Grouped.

      Allowed values:

      • true (On)
      • false (Off)

      row_filter.button_group_width_mode string

      Button group width.

      Allowed values:

      • auto (Auto)
      • full (Full)
      • fixed (Fixed)

      row_filter.button_group_width_fixed number

      Width.

      Max: 100

      row_filter.dropdown_width_mode string

      Dropdown width.

      Allowed values:

      • auto (Auto)
      • full (Full)
      • fixed (Fixed)

      row_filter.dropdown_width_fixed number

      Width.

      Max: 100

      row_filter.slider_width number

      Slider width. Width of the slider track in rems

      Max: 100

      row_filter.slider_max_label_width number

      Max label width. In rems, multiples of base font size. If larger than the longest label, only the space required to fit labels will be used.

      Max: 100

      row_filter.slider_step_time number

      Time between steps. Measured in seconds, positive values move the slider left to right, negative values move the slider right to left.

      Min: -100

      Max: 100

      row_filter.slider_loop boolean

      Loop.

      row_filter.slider_restart_pause number

      Pause before loop. Measured in seconds and in addition to the regular step time displayed above

      Max: 100

      row_filter.sort boolean

      Sorting.

      Allowed values:

      • true (On)
      • false (Off)

      controls_style.font_size number

      Text size.

      Max: 5

      controls_style.font_weight string

      Text weight.

      Allowed values:

      • bold (Bold)
      • normal (Normal)

      controls_style.height number

      Height.

      Max: 5

      Background.

      Text color.

      Dropdown border styles.

      Border style. Show border on all sides, or only at the bottom

      Allowed values:

      • all (All sides)
      • bottom (Bottom)

      Border width.

      Max: 20

      Color.

      Transparency.

      Max: 1

      Radius.

      Max: 100

      button_style.background color

      Background.

      button_style.background_selected color

      Selected.

      button_style.background_hover color

      Mouse over.

      button_style.font_color color

      Text color.

      button_style.font_color_selected color

      Selected.

      button_style.font_color_hover color

      Mouse over.

      button_style.button_styles_advanced boolean

      Button border styles.

      button_style.border_width number

      Border width.

      Max: 20

      button_style.border_color color

      Color.

      button_style.border_transparency number

      Transparency.

      Max: 1

      button_style.border_radius number

      Radius.

      Max: 100

      slider_style.track_color color

      Track.

      slider_style.font_color color

      Text.

      slider_style.handle_color color

      Handle.

      slider_style.play_color color

      Play/pause.

      slider_style.track_height number

      Track height.

      Max: 1

      slider_style.handle_height number

      Height.

      Max: 10

      slider_style.play_button boolean

      Play button.

      controls_container.alignment string

      Alignment.

      Allowed values:

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

      controls_container.controls_spacing number

      Spacing. The space between controls, like dropdowns and adjacent button sets, in em units.

      Max: 5

      Popups & panels

      popup.mode string

      Allowed values:

      • none (None)
      • popup (Popup)
      • panel (Panel)
      • both (Both)

      popup.popup_is_custom boolean

      Popup content.

      Allowed values:

      • false (Auto)
      • true (Custom)

      popup.show_popup_styles boolean

      Show popup styles.

      popup.popup_custom_header html

      Popup custom header. Use {{column_name}} to add a value from your data. Ensure the column is selected, or add it to Info for popups for popup use.

      Advanced users can add HTML styling or add category colors to popup headers.

      To hide parts of the popup when a column is empty using

      {{#if column_name}}Content for non-empty column_name{{/if}}.
      For example:
      {{#if Capital name}}Capital:{{/if}} {{Capital name}}.
      Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.

      popup.popup_custom_main html

      Popup custom main content. Use {{column_name}} to add a value from your data. Ensure the column is selected, or add it to Info for popups for popup use.

      Advanced users can add HTML for designs, styles, and images.

      To hide parts of the popup when a column is empty use the syntax

      {{#if column_name}}Content for non-empty column_name{{/if}}.
      For example:
      {{#if Capital name}}Capital:{{/if}} {{Capital name}}.
      Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.

      popup.popup_custom_accessible text

      Popup custom accessible content. A text alternative to visual custom popup content that will be read out by screenreaders. This content is added as an aria-label attribute to data point elements. You can still use {{column_name}} to add values from your data, but do not use HTML. For example: {Name}}, Population: {{Population}}, GDP: {{GDP}} If left empty, accessible content will fallback to the default popup content.

      popup.popup_width number

      Max width. In rems, multiples of base font size. Leave blank to let the width adjust based on the contents.

      popup.popup_font_size number

      Text size.

      popup.popup_text_color color

      Text color.

      popup.popup_align string

      Align.

      Allowed values:

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

      popup.popup_background color

      Fill color.

      popup.popup_background_opacity number

      Fill opacity.

      Max: 1

      popup.popup_padding number

      Padding.

      popup.popup_radius number

      Radius. Corner radius of popup

      popup.popup_header_type string

      Header style.

      Allowed values:

      • block (Header block)
      • inline (Header inline)

      popup.popup_header_background color

      Background.

      popup.popup_header_text_color color

      Text.

      popup.popup_list_type string

      List type.

      Allowed values:

      • table (fa-table)
      • ul (fa-list)

      popup.popup_list_label_weight string

      Label weight.

      Allowed values:

      • normal (Normal)
      • bold (Bold)

      popup.popup_list_separator string

      List separator.

      Predefined values:

      • : (:)
      • (–)
      • (Empty space)
      • <br /> (Line break)

      popup.popup_shadow boolean

      Shadow.

      popup.popup_pointer boolean

      Pointer.

      popup.panel_position string

      Allowed values:

      • overlay (Overlay)
      • left (Left)
      • right (Right)
      • top (Top)
      • bottom (Bottom)

      popup.panel_open_duration number

      Open duration.

      Max: 2000

      popup.panel_side_fixed boolean

      Always show.

      popup.panel_side_default_content text

      Placeholder content.

      popup.panel_is_custom boolean

      Panel content.

      Allowed values:

      • false (Auto)
      • true (Custom)

      popup.show_panel_styles boolean

      Show panel styles.

      popup.panel_custom_header html

      Panel custom header. Use {{column_name}} to add a value from your data. Ensure the column is selected, or add it to Info for popups for panel use.

      Advanced users can add HTML for styling or add category colors to panel headers.

      To hide parts of the panel when a column is empty using

      {{#if column_name}}Content for non-empty column_name{{/if}}.
      For example:
      {{#if Capital name}}Capital:{{/if}} {{Capital name}}.
      Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.

      popup.panel_custom_main html

      Panel custom main content. Use {{column_name}} to add a value from your data. Ensure the column is selected, or add it to Info for popups for panel use.

      Advanced users can add HTML for designs, styles, images, videos and embedded Flourish charts,

      To hide parts of the panel when a column is empty using

      {{#if column_name}}Content for non-empty column_name{{/if}}.
      For example:
      {{#if Capital name}}Capital:{{/if}} {{Capital name}}.
      Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.

      popup.panel_width_overlay number

      Width (%).

      popup.panel_height_overlay number

      Height (%).

      popup.panel_width_side number

      Width (%).

      popup.panel_height_side number

      Height (%).

      popup.panel_max_width number

      Max width (px).

      popup.panel_max_height number

      Max height (px).

      popup.panel_vertical_position string

      Vertical position. Choosing Click position is especially useful when your visualization is really tall, this will make sure the panel content is always on top of the element you've clicked on

      Allowed values:

      • click (Click position)
      • center (Center)

      popup.panel_text_color color

      Text color.

      popup.panel_font_size number

      Text size.

      popup.panel_align string

      Alignment.

      Allowed values:

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

      popup.panel_background color

      Fill color.

      popup.panel_background_opacity number

      Fill opacity.

      Max: 1

      popup.panel_padding number

      Padding.

      popup.panel_radius number

      Radius. Corner radius of panel

      popup.panel_list_type string

      List type.

      Allowed values:

      • table (fa-table)
      • ul (fa-list)

      popup.panel_list_label_weight string

      Label weight.

      Allowed values:

      • normal (Normal)
      • bold (Bold)

      popup.panel_list_separator string

      List separator.

      Predefined values:

      • : (:)
      • (–)
      • (Empty space)
      • <br /> (Line break)

      popup.panel_shadow boolean

      Shadow.

      Number formatting

      formatter.prefix string

      Prefix. Text to place in front of number

      formatter.suffix string

      Suffix. Text to place after number

      formatter.n_dec number

      Decimal places. Enter a negative integer to round to a whole number with that many zeros. For example, -2 will round to the nearest hundred.

      Max: 10

      formatter.advanced boolean

      Advanced.

      formatter.negative_sign string

      Styling of negative numbers.

      Allowed values:

      • -$nk (-$100k)
      • $-nk ($-100k)
      • ($nk) (($100k))
      • $(n)k ($(100)k)
      • none ($100k)

      formatter.strip_zeros boolean

      Remove trailing zeros.

      formatter.strip_separator boolean

      Hide thousands separator below 10,000. Turn off if you want four-digit numbers to include a separator, e.g. “1,234” rather than “1234”.

      formatter.transform_labels boolean

      Multiply/divide values.

      formatter.transform string

      Allowed values:

      • multiply (Multiply by)
      • divide (Divide by)
      • exponentiate (×10 to the power of)

      formatter.multiply_divide_constant number

      formatter.exponentiate_constant number

      localization.input_decimal_separator string

      Decimal separator in data sheet. Used for interpreting your data. Only change if data is not displaying on the chart as expected.

      Allowed values:

      • . (.)
      • , (,)

      localization.output_separators string

      Number format to display. How the numbers should appear on chart labels

      Allowed values:

      • ,. (12,235.67)
      • ., (12.345,67)
      • . (12235.67)
      • , (12345,67)
      • . (12 235.67)
      • , (12 345,67)

      Layout

      Layout

      layout.body_font font

      Main font. This font will apply to the whole graphic by default. 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, 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 (Header – controls – legend – primary graphic – footer)
      • stack-2 (Primary graphic – header – controls – legend – footer)
      • stack-3 (Header – primary graphic – controls – legend – footer)
      • stack-4 (Controls – primary graphic – header – controls – legend – footer)
      • grid-1 (Grid mode: Primary graphic on the right)

      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. It's 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.font_size_mobile_small number

      layout.font_size_mobile_big number

      layout.font_size_tablet number

      layout.font_size_desktop number

      layout.font_size_big_screen number

      layout.breakpoint_mobile_small number

      layout.breakpoint_mobile_big number

      layout.breakpoint_tablet number

      layout.breakpoint_desktop number

      layout.breakpoint_big_screen number

      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 in rems. The 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 in rems. The 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 in rems. The 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.

      layout.header_logo_alt string

      Alt text.

      Link.

      layout.header_logo_height number

      Height.

      layout.header_logo_align string

      Align. Align logo inside either the header or the main visualization 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 html

      Note.

      layout.footer_note_secondary html

      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 color is dark

      layout.footer_logo_alt string

      Alt text.

      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_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".

      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)

      URL state

      url_state.enabled boolean

      Update project from URL. Make it possible to change the visualization's settings/state from the URL hash, for example when embedding in an iframe or popup panel

      url_state.whitelist text

      Allowed state properties. List each state property you want to make changeable with the URL hash. See the template page for a full list of state properties.

      Add one property name per line. Use dot format for nested properties, e.g. layout.background_color.