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

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: "5",
    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: "5",
    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: "5",
    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: "5",
    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: "5",
    data: {
    rows: [
        {
            columns: [...]
        },
        ...
    ]
},
    ...
}

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

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

Meanings of the template data keys:

• rows.columns: columns

Template settings

Options for opts.state.

Table

table_min_width number

Min width.

table_border_width number

Border thickness.

table_border_color color

Border color.

sorting.enabled boolean

Column sorting.

pagination_amount number

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

markdown_enabled boolean

Cell text styling. Enables Markdown style parsing for your cells. For example for italic, bold text. Go to template guide for full documentation.

Cell styles

cell_height number

Height.

cell_padding_vertical number

Padding vertical.

cell_padding_horizontal number

Padding horizontal.

cell_vertical_alignment string

Vertical alignment.

cell_horizontal_alignment string

Horizontal alignment.

cell_wrap boolean

Wrap text in cell.

cell_fill_1 color

First color.

cell_fill_2 color

Stripe color.

cell_fill_direction string

Stripe direction.

cell_fill_custom text

Custom cell colors based on content. Color cells based on their content. Use the format “cell-text: background-color” or “cell-text: background-color/text-color”. Eg:

Alabama: #0000dd/#ffffff

cell_border_color color

Color.

cell_border_width number

Thickness.

cell_border_style string

Style.

cell_font_color color

Color.

cell_link_color color

Link color.

cell_font_size string

Size.

cell_font_size_custom number

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

column_width_mode string

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_font_weight string

Text weight.

header_horizontal_alignment string

Alignment.

header_fill color

Background.

header_font_color color

Color.

header_style_default boolean

header_height number

Height.

header_padding number

Padding.

header_font_default boolean

header_font_size number

Size.

header_border_default boolean

header_border_color color

Color.

header_border_width number

Thickness.

header_border_style string

Style.

cell_image_height number

Height.

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.

Charts 📊📉

bar_columns.enabled boolean

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

bar_columns.type string

Type.

bar_columns.bar_1_width number

Width.

bar_columns.bar_1_column_padding number

Padding.

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

Max. Use a fixed max value

bar_columns.bar_1_max number

Max value.

color.palette colors

Palette.

color.extend boolean

Auto-extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once. Added colours are based on the average lightness and chroma values of the palette. This works best if the palette’s colours do not have very high or low saturation.

color.advanced boolean

Fine tune. Fine tune how additional colours are added to the palette.

color.hue_rotation_angle number

Hue rotation for added colours. Angle, in degrees in HCL colourspace, between one generated colour and the next. The default value, ~360/(Golden ratio), ensures adjacent hues are not too similar.

color.custom_palette text

Custom overrides. Type the name of the entity whose colour you want to set, a colon and then a colour (using a name, hex-code or rgb declaration). Multiple colours can be set using multiple lines. For example:

---

Party 1: red
Party 2: #4455AA
Party 3: rgb(30,168,26)

line_columns.enabled boolean

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

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_color color

Color.

line_columns.line_1_area boolean

Area chart.

line_columns.line_1_min_enabled boolean

Min. Use a fixed min value

line_columns.line_1_min number

Min value.

line_columns.line_1_max_enabled boolean

Max. Use a fixed max value

line_columns.line_1_max number

Max value.

Mobile view

mobile.view boolean

Mobile view.

mobile.breakpoint number

Mobile breakpoint width.

mobile.cell_font_size string

Text size.

mobile.cell_font_size_custom number

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

mobile.pagination_amount number

Pagination Amount.

Search

search_enabled boolean

search_width number

Width. Width of search container

search_placeholder string

Placeholder.

search_hide_table boolean

Hide table before search.

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 \n Column B"

search_columns_custom text

no_results_text string

Text when there are no results.

search_resize boolean

Resize table after searching.

Popup

popup.show_popups boolean

Popups.

popup.is_custom boolean

Popup contents.

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.

popup.font_size number

Font size.

popup.fill_color color

Fill colour.

popup.opacity number

Fill opacity.

popup.padding number

Padding.

popup.border_radius number

Radius. Corner radius of popup

Number formatting

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.

localization.output_separators string

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

formatted_columns text

Columns to format. Write down the column names on a new line

number_format.prefix string

Prefix. Text to place in front of number

number_format.suffix string

Suffix. Text to place after number

number_format.n_dec number

Decimal places. Use negative integers to round to positive powers of ten (eg -2 rounds to the nearest 100)

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

number_format.multiply_divide_constant number

number_format.exponentiate_constant number

Layout

Layout

layout.body_font font

Font.

layout.max_width number

Maximum width. Leave blank to stretch to container width

layout.margin number

Margin.

layout.background_color_enabled boolean

Color.

layout.background_image_enabled boolean

Image.

layout.background_color color

Color.

layout.background_image_src url

Image URL.

layout.background_image_size string

Size.

layout.background_image_position string

Position.

layout.layout_order string

Layout order.

layout.space_between_sections string

Space between sections.

layout.space_between_sections_custom number

Custom.

Header

layout.header_align string

Alignment.

layout.title string

layout.title_styling boolean

Change title styles.

layout.title_size string

Size.

layout.title_size_custom number

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

layout.title_weight string

Weight.

layout.title_color color

Color.

layout.title_line_height number

Line height.

layout.subtitle string

layout.subtitle_styling boolean

Change subtitle styles.

layout.subtitle_size string

Size.

layout.subtitle_size_custom number

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

layout.subtitle_weight string

Weight.

layout.subtitle_color color

Color.

layout.subtitle_line_height number

Line height.

layout.subtitle_space_above string

Space above.

layout.subtitle_space_above_custom number

Custom.

layout.text string

layout.text_styling boolean

Change text styles.

layout.text_size string

Size.

layout.text_size_custom number

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

layout.text_weight string

Weight.

layout.text_color color

Color.

layout.text_line_height number

Line height.

layout.text_space_above string

Space above.

layout.text_space_above_custom number

Custom.

Footer

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

Note.

layout.size number

Size.

layout.color color

Color.

layout.footer_align string

Alignment.

layout.logo_url url

Image.

layout.logo_link_url string

Link.

layout.logo_height number

Height.

layout.logo_margin number

Margin.

layout.logo_order string

Position.

layout.footer_align_vertical string

V. align.