Table

Upload CSV or Excel data to create a searchable, sortable table

Updated 13 hours ago to v19.0.2 by Flourish team

How to use this template

This is a beta template, and we would love to know what you think of it! Send us an e-mail if you have any requests, problems or questions.

What's it for?

This template allows you make a template in which your audience can search, filter and explore. Pretty boring, huh? Luckily, we added a way to turn your columns into mini visualisations! For now you can make a basic bar chart, but we'll be adding more visualisation types very soon.

How to get started

  1. Upload your data
  2. Done πŸ™‚
  3. Want to turn your columns into mini bar charts? Go to "Chart columns" on the right hand side and type in the column names

FAQ

Tell me more about those mini visualisations

Of course. Let's say you have election results for each state in America. We have a column for state name, population, Republican %, Democrat%.

Now we want to turn Republican % and Democrat% into a bar chart, so we can immediately see the vote results for each state.

  1. Go to "Chart columns" on the right hand side, and enable "Bar Chart Columns"
  2. Fill in Democrats %, Republicans %
  3. This should turn the two columns into a new column with the bar chart
  4. Give the newly made bar chart a name

Can I change the text styling for some cells

Yes, you can. The cells can be parsed with something called "Markdown". This is a mini language that allows you to format text. For example, you can use **double asterisks** to make text bold, or *single asterisks* to make text italic. There are many other things you can do with Markdown, such as adding urls, images, titles, lists and HTML. We recommend taking a look at the full Markdown documentation.

How do I add images to the table

The template will automatically turn image urls into images inside the table. If you would like to show the actual url inside your table, then just add a character either at the start or end of the url.

Can I add additional information to a cell?

Yes, you can do that via a popup. Just add ">>" to the cell followed by the text you want to display in the popup. So a cell containing "London >> Capital of England" will show up as "London", but when you hover over it, will show a popup with "Capital of England".

Can I also use this as a searchable tool

Yes! Just go to the "Search" setting panel and tick the box "Hide results before search".

Does this table work with a lot of data?

It works pretty quickly, even with about 100,000 rows of data. You can optimize it by limiting the columns to search through.

So what happens on mobile?

We've made it quite flexible for you. You could choose to switch to a mobile blocks view, but if you prefer to keep a table view (with scrollbars) than that's also possible.

Credits

Created by the Flourish team. The data for this chart comes from US Census and the US Federal Election Commission.

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

version: 19

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: {
        rows: [
            [ "RowsColumn1Value1", "RowsColumn2Value1",
            [ "RowsColumn1Value2", "RowsColumn2Value2",
            [ "RowsColumn1Value3", "RowsColumn2Value3",
            ...
        ]
    }
}

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/table",
    version: "19",
    bindings: {
        rows: {
            
        }
    },
    data: {
        rows: [
            [ "RowsColumn1Value1", "RowsColumn2Value1",
            [ "RowsColumn1Value2", "RowsColumn2Value2",
            [ "RowsColumn1Value3", "RowsColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@flourish/table",
    version: "19",
    bindings: {
        rows: {
            columns: [0, 1, ...], // index(es) of column(s) in your data
        }
    },
    data: {
        rows: [
            [ "RowsColumn1Value1", "RowsColumn2Value1",
            [ "RowsColumn1Value2", "RowsColumn2Value2",
            [ "RowsColumn1Value3", "RowsColumn2Value3",
            ...
        ]
    }
}

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:

{
        rows: [
            { "RowsHeader1": ..., "RowsHeader2": ..., ... },
            { "RowsHeader1": ..., "RowsHeader2": ..., ... },
            { "RowsHeader1": ..., "RowsHeader2": ..., ... },
            ...
        ]
    }

... 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/table",
    version: "19",
    bindings: {
        rows: {
            
        }
    },
    data: {
        rows: [
            { "RowsHeader1": ..., "RowsHeader2": ..., ... },
            { "RowsHeader1": ..., "RowsHeader2": ..., ... },
            { "RowsHeader1": ..., "RowsHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/table",
    version: "19",
    bindings: {
        rows: {
            columns: ["RowsHeader1", "RowsHeader2", ...],
        }
    },
    data: {
        rows: [
            { "RowsHeader1": ..., "RowsHeader2": ..., ... },
            { "RowsHeader1": ..., "RowsHeader2": ..., ... },
            { "RowsHeader1": ..., "RowsHeader2": ..., ... },
            ...
        ]
    }
}

(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/table",
    version: "19",
    data: {
    rows: [
        {
            columns: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/table",
    version: "19",
    data: {
    rows: [
        {
            columns: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

  • rows.columns: The cell contents can by styled with <a href="https://helpcenter.flourish.studio/hc/en-us/articles/8761551046671-How-to-use-custom-HTML-and-CSS">html</a> or <a href="https://helpcenter.flourish.studio/hc/en-us/articles/8761563146255-How-to-format-text-in-the-Table-template">markdown</a>. To style with markdown first make sure the <b>Cell text styling</b> setting in the <b>Table</b> section of the editor is <b>on</b>. <br><br>To add an <a href="https://helpcenter.flourish.studio/hc/en-us/articles/8827970581391-How-to-add-images-to-your-visualization">image</a>, right click on a cell and click <b>Upload file</b>. string, number, datetime

Template metadata

Note: metadata is optional, and the API will interpret your data for you if you do not specify it. A typical example of when specifying metadata can be useful is when column(s) in your data contain numbers or dates that you wish to format visually (e.g. to display a column containing MM/DD/YYYY dates in DD/MM/YYYY format).

This template supports an optional metadata property. metadata informs the template what type of data is in each of your columns, and how that data should be formatted visually.

You can specify metadata in one of three formats, depending on the format of opts.data.

1. Array of objects with column indexes as keys

You should supply metadata in this format when opts.data is in the previously described 'array of arrays' format. In this case, metadata should be an object with column index: column type object key/value pairs (column type objects must have type, type_id, and output_format_id keys, documented below):

{
    template: "@flourish/table",
    version: "19",
    ...
    data: {
        rows: [
            [ "RowsColumn1Value1", "RowsColumn2Value1",
            [ "RowsColumn1Value2", "RowsColumn2Value2",
            [ "RowsColumn1Value3", "RowsColumn2Value3",
            ...
        ]
    },
    metadata: {
        rows: {
            0: { type: ..., type_id: ..., output_format_id: ... },
        }
    },
    ...
}

2. Array of objects with column headers as keys

You should supply metadata in this format when opts.data is in the previously described 'array of objects with arbitrary keys' format. In this case, metadata should be an object with column header: column type object key/value pairs (column type objects must have type, type_id, and output_format_id keys, documented below):

{
    template: "@flourish/table",
    version: "19",
    data: {
        rows: [
            { "RowsHeader1": ..., "RowsHeader2": ..., ... },
            { "RowsHeader1": ..., "RowsHeader2": ..., ... },
            { "RowsHeader1": ..., "RowsHeader2": ..., ... },
            ...
        ]
    },
    metadata: {
        rows: {
            "RowsHeader1": { type: ..., type_id: ..., output_format_id: ... },
        }
    },
    ...
}

Column type objects:

Column type objects tell the API what type of data is in a column:

{
    type: "number", // options also include 'string', and 'datetime'
    type_id: "number$comma_point", // numbers in the format 13,429.17
    output_format_id: "number$space_comma", // numbers in the format 13 429,17
}

For more information on valid column type values, see Recognized Type Formats.

Template settings

Options for opts.state.

Table

table_min_width number

Min width.

Min: 100

table_border_width number

Border.

table_border_color color

Border color.

sorting.enabled string

Sortable columns. Determines whether a viewer can sort the table by clicking on the column headers. Custom allows the user only to sort listed columns.

Allowed values:

  • all (All)
  • none (None)
  • custom (Custom)

sorting.custom_columns text

Columns to make sortable. Write each column name you want to make sortable on a new line

pagination_amount number

Rows per page. If you don't want pagination, set this number to a value greater than the number of rows in your data

Max: 5000

markdown_enabled boolean

Cell text styling. Enables Markdown for your cells. For example for italic, bold text.

Allowed values:

  • true (On)
  • false (Off)

Table cell styles

cell_height number

Min height.

cell_padding_vertical number

Padding vertical.

Max: 5

cell_padding_horizontal number

Padding horizontal.

Max: 5

cell_wrap boolean

Wrap text in cell.

cell_horizontal_alignment string

Text.

Allowed values:

  • start (Start)
  • center (Center)
  • end (End)

cell_numeric_horizontal_alignment string

Numbers.

Allowed values:

  • start (Start)
  • center (Center)
  • end (End)

cell_vertical_alignment string

Vertical alignment.

Allowed values:

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

cell_fill_1 color

Main color.

cell_fill_2 color

Stripe color.

cell_fill_direction string

Stripe direction.

Allowed values:

  • horizontal (Horizontal)
  • vertical (Vertical)

cell_fill_custom_enabled boolean

Color cells based on content.

cell_fill_custom_categorical text

Categorical coloring. To color cells based on their content, use the format:

 cell-color/text-color : cell-text : column name OR row-number
To specify a row, write "row-" followed by the row number from the datasheet.

It's also possible to leave out the column name or row number if you want to target all the cells in the table. For example:
 red/white : Chelsea 
Use * in place of cell-text to select an entire column or row. For example:
 #0000dd/#ffffff : Alabama 
#ffffff/#dddddd : * : State
#0000dd/#ffffff : * : row-2
#ffffff/#dddddd : n/a : Capital

cell_fill_custom_numeric text

Numeric coloring. Color cells numerically based on their content. For sequential coloring, use the format:

 min_color >> max_color : column_name : domain_min >> domain_max 

The domain is optional, for example:
 #ffffff >> #00ff00 : Population
#ffffff >> #00ff00 : Population : 0 >> 1000000000

For diverging coloring, use the format:
 min_color >> midpt_color >> max_color : col_name : domain_min >> domain_mid >> domain_max 

The domain is optional, for example:
 #ffffff >> #00ff00 >> #ff00ff : Vote share
#ffffff >> #00ff00 >> #ff00ff : Vote share : 0 >> 50 >> 100

Where both numeric and categorical coloring are used on a cell, categorical will override numeric.

cell_fill_margin_vertical number

Vertical margin.

cell_fill_margin_horizontal number

Horizontal margin.

cell_border_mode string

Mode.

Allowed values:

  • none (None)
  • horizontal (Horizontal)
  • vertical (Vertical)
  • both (Both)

cell_border_color color

Color.

cell_border_width number

Thickness.

cell_border_style string

Style.

Allowed values:

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

cell_font_color color

Color.

Link color.

cell_font_size string

Size.

Allowed values:

  • 1 (α΄€)
  • 1.25 (A)
  • 1.5 (fa-font)
  • custom (...)

cell_font_size_custom number

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

column_width_mode string

Allowed values:

  • auto (Auto)
  • equal (Equally spaced)
  • fixed (Custom)

column_widths string

Column widths. A comma separated lists of column widths. The first column will be the first number in the list. You can use "px" to set fixed widths or "%" to use percentage of total width. (e.g. 200px,200px,25%)

Header cell styles

header_font_weight string

Text weight.

Allowed values:

  • bold (Bold)
  • normal (Normal)

header_fill color

Background.

header_font_color color

Color.

header_underline_sorting boolean

Underline sorting header.

header_style_default boolean

Allowed values:

  • true (Inherit styles)
  • false (Custom)

header_height number

Height.

header_padding number

Padding.

Max: 5

header_horizontal_alignment string

Horizontal alignment.

Allowed values:

  • start (Start)
  • center (Center)
  • end (End)

header_font_default boolean

Allowed values:

  • true (Inherit styles)
  • false (Custom)

header_font_size number

Size.

header_border_default boolean

Allowed values:

  • true (Inherit styles)
  • false (Custom)

header_border_color color

Color.

header_border_width number

Thickness.

header_border_style string

Style.

Allowed values:

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

Mini bar charts πŸ“Š

bar_columns.enabled boolean

This setting will convert numerical values in your data to a simple visual bar chart

Allowed values:

  • true (Enabled)
  • false (Disabled)

bar_columns.bar_1_columns text

Which columns should be part of the bar chart?. Just write down the column names on a new line

bar_columns.bar_1_column_name string

New column name.

bar_columns.type string

Bar type.

Allowed values:

  • bars (Horizontal)
  • columns (Vertical)

bar_columns.bar_1_height number

Max height.

bar_columns.bar_1_width number

Width.

bar_columns.bar_1_column_padding number

Padding.

bar_columns.bar_1_proportional boolean

Mode. Display data in a proportional bar chart or a standard stacked bar chart with a fixed min and max, e.g. for negative numbers

Allowed values:

  • false (Stacked normal)
  • true (Stacked %)

bar_columns.bar_1_same_scale boolean

Consistent scale. If enabled, all the bar charts in the table will use the same X scale

bar_columns.bar_1_zero_line boolean

Show zero line.

bar_columns.bar_1_zero_line_color color

Zero line color.

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.

      bar_columns.bar_1_labels string

      Labels.

      Allowed values:

      • none (None)
      • popup (Popup)
      • inline (Inline)

      bar_columns.bar_1_label_size number

      Inline label size.

      legend.show_legend boolean

      Legend. A legend will not show with a single entry

      Allowed values:

      • true (Enabled)
      • false (Disabled)

      legend.title_mode string

      Title mode.

      Allowed values:

      • auto (Auto)
      • custom (Custom)

      legend.title string

      Title.

      legend.swatch_width number

      Width.

      legend.swatch_height number

      Height.

      legend.swatch_radius number

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

      legend.legend_items_padding number

      Padding. Padding between legend items (in rems)

      legend.swatch_outline boolean

      Outline. An optional outline for the swatch in the legend

      legend.swatch_outline_color color

      Color.

      legend.order_override text

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

      legend.icon_height number

      Height. Height of icon (in rems)

      legend.icon_color color

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

      legend.max_width number

      Max width.

      legend.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

      Mini line charts πŸ“‰

      line_columns.enabled boolean

      This setting will convert numerical values in your data to a simple visual line chart

      Allowed values:

      • true (Enabled)
      • false (Disabled)

      line_columns.line_1_columns text

      Which columns should be part of the line chart?. Write down the column names on a new line

      line_columns.line_1_column_name string

      New column name.

      line_columns.line_1_width number

      Width.

      line_columns.line_1_height number

      Max height.

      line_columns.line_1_color color

      Color.

      line_columns.line_1_area boolean

      Area chart.

      Allowed values:

      • true (On)
      • false (Off)

      line_columns.line_1_min_enabled boolean

      Min. Use a fixed min value

      Allowed values:

      • true (On)
      • false (Off)

      line_columns.line_1_min number

      Min value.

      line_columns.line_1_max_enabled boolean

      Max. Use a fixed max value

      Allowed values:

      • true (On)
      • false (Off)

      line_columns.line_1_max number

      Max value.

      Image styles

      cell_image_height number

      Height. As a percentage of the cell height. To include images in your table, simply upload them to the datasheet.

      Max: 500

      cell_image_radius number

      Rounded corners. Sets the radius of the corner roundness (in %). A value of 50 means your image will show as a circle.

      Max: 50

      Mobile view

      mobile.view boolean

      Mobile view.

      Allowed values:

      • false (Table (scrollbars))
      • true (Blocks)

      mobile.breakpoint number

      Mobile breakpoint width.

      Min: 10

      mobile.cell_font_size string

      Text size.

      Allowed values:

      • 1 (α΄€)
      • 1.25 (A)
      • 1.5 (fa-font)
      • custom (...)

      mobile.cell_font_size_custom number

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

      mobile.pagination_amount number

      Rows per page. If you don't want pagination, set this number to a value greater than the number of rows in your data

      Min: 1

      search_enabled boolean

      Allowed values:

      • true (Enabled)
      • false (Disabled)

      search_mode string

      Search mode. Anywhere: Search for the specified text anywhere in the cell

      Start: Search for the specified text at the beginning of the cell

      Whole: Search for the exact specified text in the cell

      Allowed values:

      • anywhere (Anywhere)
      • start (Start)
      • whole (Whole)

      search_width number

      Width. Width of search container

      Min: 4

      search_background_color color

      Background.

      search_text_color color

      Text color.

      search_placeholder string

      Placeholder text.

      no_results_text string

      Text when no results.

      search_hide_table boolean

      Hide table before search.

      search_hide_published boolean

      Hide search when published. Keeps the search box visible in the editor (e.g. for filtering in a story) but hides it in the published visualization or story.

      search_columns string

      Columns to search. Choose which columns you want to search through. You might want to narrow this down with big datasets to speed it up. You can select specific columns by writing them down on a new line, like this:


      Column A
      Column B

      Allowed values:

      • all (All)
      • first (First)
      • custom (Selected)

      search_columns_custom text

      search_resize boolean

      Resize table after searching.

      Allowed values:

      • true (Enabled)
      • false (Disabled)

      search_dropdown boolean

      Allowed values:

      • true (Enabled)
      • false (Disabled)

      search_dropdown_persistent boolean

      Always show dropdown suggestions.

      search_val hidden

      Search value. The current string value of the search box

      popup.show_popups boolean

      Popups.

      Allowed values:

      • true (Enabled)
      • false (Disabled)

      popup.is_custom boolean

      Popup contents.

      Allowed values:

      • false (Auto)
      • true (Custom content)

      popup.custom_template text

      Popup content. The text to appear in the popup. You can use {{column_name}} to add a value from your data. It must be in a selected column, but you can add columns to β€œMetadata” if you just want to include them for use in the popup. Advanced users can include HTML to apply layouts, formatting, images, etc.

      popup.show_pointer boolean

      Pointer.

      popup.show_shadow boolean

      Shadow.

      popup.style_popups boolean

      Custom styling.

      popup.text_color color

      Text colour.

      popup.align string

      Alignment.

      Allowed values:

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

      popup.text_size number

      Font size.

      Max: 10

      popup.fill_color color

      Fill colour.

      popup.opacity number

      Fill opacity.

      Max: 1

      popup.padding number

      Padding.

      Max: 10

      popup.border_radius number

      Radius. Corner radius of popup

      popup.max_width number

      Max width.

      Max: 50

      Number formatting

      formatted_columns text

      Columns to format. Write down the column names on a new line that you want to apply formatting to

      number_format.prefix string

      Prefix. Text to place in front of a number

      number_format.suffix string

      Suffix. Text to place after a number

      number_format.n_dec number

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

      Min: -10

      Max: 10

      number_format.advanced boolean

      Advanced.

      number_format.negative_sign string

      Styling of negative numbers.

      Allowed values:

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

      number_format.strip_zeros boolean

      Remove trailing zeros.

      number_format.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”.

      number_format.transform_labels boolean

      Multiply/divide values.

      number_format.transform string

      Allowed values:

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

      number_format.multiply_divide_constant number

      number_format.exponentiate_constant number

      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 – 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. To add the time/date stamp of when the data was last updated add {{data_last_updated}}. For example, "Last updated at {{data_last_updated}}". To customize the format, use the advanced options below.

      layout.footer_note_secondary html

      Note (secondary). The secondary note is placed below the source and primary note. To add the time/date stamp of when the data was last updated add {{data_last_updated}}. For example, "Last updated at {{data_last_updated}}". To customize the format, use the advanced options below.

      layout.advanced_note_styling boolean

      Advanced.

      layout.footer_timestamp_format string

      Time/date stamp formatting. To change the date/time format of your timestamp, choose from the below options or provide a custom date format in d3-time-format syntax

      Predefined values:

      • %H:%M:%S (13:39:13)
      • %I:%M %p (01:39 PM)
      • %H:%M (13:39)
      • %H:%M %p (13:39 PM)
      • %H:%M:%S, %d %b %Y (13:39:13, 28 Jan 2024)
      • %H:%M, %d %b %Y (13:39, 28 Jan 2024)
      • %H:%M, %d/%m/%Y (13:39, 28/01/2024)
      • %H:%M, %m/%d/%Y (13:39, 01/28/2024)
      • %H:%M, %d-%m-%Y (13:39, 28-01-2024)
      • %H:%M, %m-%d-%Y (13:39, 01-28-2024)
      • %d %b %Y (28 Jan 2024)
      • %m/%d/%Y (01/28/2024)
      • %d/%m/%Y (28/01/2024)
      • %m-%d-%Y (01-28-2024)
      • %d-%m-%Y (28-01-2024)
      • %Y-%m-%d (2024-01-28)
      • %Y-%m-%d %H:%M:%S (2024-01-28 13:39:13)

      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 settings

      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.