Table
Updated 2 years ago to v14.0.3 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
- Upload your data
- Done π
- 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.
- Go to "Chart columns" on the right hand side, and enable "Bar Chart Columns"
- Fill in Democrats %, Republicans %
- This should turn the two columns into a new column with the bar chart
- 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.
API information
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: 14
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: "14",
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: "14",
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: "14",
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: "14",
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: "14",
data: {
rows: [
{
columns: [...]
},
...
]
},
...
}
And the full list of all possible properties is as follows:
{
template: "@flourish/table",
version: "14",
data: {
rows: [
{
columns: [...]
},
...
]
},
...
}
Meanings of the template data keys:
- rows.columns: columns 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: "14",
...
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: "14",
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 Allowed values:
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 higher than the length of your data Max: 5000
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. Allowed values:
Table cell styles
cell_height number
Min height.
cell_padding_vertical number
Padding vertical.
cell_padding_horizontal number
Padding horizontal.
cell_vertical_alignment string
Vertical alignment. Allowed values:
cell_horizontal_alignment string
Horizontal alignment. Allowed values:
cell_wrap boolean
Wrap text in cell.
cell_fill_1 color
Main color.
cell_fill_2 color
Stripe color.
cell_fill_direction string
Stripe direction. Allowed values:
cell_fill_custom_enabled boolean
Color cells based on content.
cell_fill_custom text
Cells to color. 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 data table. It's also possible to leave out the column name or row number, if you want to target all the cells in the table. Use * in place of cell-text to select an entire column or row. Eg: #0000dd/#ffffff : Alabama
#ffffff/#dddddd : * : State
#0000dd/#ffffff : * : row-2
#ffffff/#dddddd : n/a : Capital
cell_fill_margin_vertical number
Vertical margin.
cell_fill_margin_horizontal number
Horizontal margin.
cell_border_color color
Color.
cell_border_width number
Thickness.
cell_border_style string
Style. Allowed values:
cell_font_color color
Color.
cell_link_color color
Link color.
cell_font_size string
Size. Allowed values:
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
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:
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.
header_horizontal_alignment string
Horizontal alignment. Allowed values:
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:
cell_image_height number
Height. as a percentage of the cell height Max: 200
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
Mini bar charts π
bar_columns.enabled boolean
This setting will convert numerical values in your data to a simple visual bar chart Allowed values:
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:
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:
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. 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)
color.numeric_type string
Scale type. Allowed values:
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:
color.bin_mode string
Binning mode. Allowed values:
color.bin_count number
Number of bins.
color.bin_thresholds string
Custom thresholds. Write your custom thresholds, separated by a ";" For example 5;10;15
color.sequential_palette string
Palette. Allowed values:
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:
color.sequential_custom_domain boolean
Domain. Allowed values:
color.sequential_domain_min number
Min.
color.sequential_domain_max number
Max.
color.diverging_palette string
Palette. Allowed values:
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:
color.diverging_custom_domain boolean
Domain. Allowed values:
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:
bar_columns.bar_1_label_size number
Inline label size.
legend.show_legend boolean
Legend. Allowed values:
legend.text_color color
Color.
legend.text_size number
Size.
legend.text_weight string
Weight. Allowed values:
legend.title_mode string
Title mode. Allowed values:
legend.title string
Title.
legend.title_weight string
Weight. Allowed values:
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.order_override text
Custom order override. Manually specify the order of legend entries (one entry per line)
legend.orientation string
Orientation. Allowed values:
legend_position string
Legend position. Allowed values:
Mini line charts π
line_columns.enabled boolean
This setting will convert numerical values in your data to a simple visual line chart Allowed values:
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:
line_columns.line_1_min_enabled boolean
Min. Use a fixed min value Allowed values:
line_columns.line_1_min number
Min value.
line_columns.line_1_max_enabled boolean
Max. Use a fixed max value Allowed values:
line_columns.line_1_max number
Max value.
Mobile view
mobile.view boolean
Mobile view. Allowed values:
mobile.breakpoint number
Mobile breakpoint width. Min: 10
mobile.cell_font_size string
Text size. Allowed values:
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
Rows per page. If you don't want pagination, set this number to a value higher than the length of your data Min: 1
Search
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:
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: Allowed values:
Column A
Column B
search_columns_custom text
search_resize boolean
Resize table after searching. Allowed values:
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
popup.show_popups boolean
Popups. Allowed values:
popup.is_custom boolean
Popup contents. Allowed values:
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:
popup.font_size number
Font size. Min: 1
popup.fill_color color
Fill colour.
popup.opacity number
Fill opacity. Max: 1
popup.padding number
Padding.
popup.border_radius number
Radius. Corner radius of popup
Number formatting
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) Min: -10 Max: 10
number_format.advanced boolean
Advanced.
number_format.negative_sign string
Styling of negative numbers. Allowed values:
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, but you can optionally change the font for the title, subtitle, footer, etc in the Header and Footer settings panels.
layout.font_color color
Text color. This color will apply to the whole graphic by default, but you can optionally change the color for individual text elements, in other settings panels.
layout.background_color_enabled boolean
Color. Allowed values:
layout.background_image_enabled boolean
Image. Allowed values:
layout.background_color color
Background color.
layout.background_image_src url
Image URL.
layout.background_image_size string
Size. Allowed values:
layout.background_image_position string
Position. Allowed values:
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:
layout.max_width number
Maximum width. Leave blank to stretch to container width Min: 50
layout.max_width_align string
Align. Allowed values:
layout.layout_order string
Layout order. Allowed values:
layout.space_between_sections string
Space between sections. Allowed values:
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:
layout.border.top.color color
Color.
layout.border.right.width number
Right.
layout.border.right.style string
Style. Allowed values:
layout.border.right.color color
Color.
layout.border.bottom.width number
Bottom.
layout.border.bottom.style string
Style. Allowed values:
layout.border.bottom.color color
Color.
layout.border.left.width number
Left.
layout.border.left.style string
Style. Allowed values:
layout.border.left.color color
Color.
Header
layout.header_align string
Alignment. Allowed values:
layout.title string
layout.title_styling boolean
Change title styles.
layout.title_font font
Title Font.
layout.title_size string
Size. Allowed values:
layout.title_size_custom number
Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3
layout.title_weight string
Weight. Allowed values:
layout.title_color color
Color.
layout.title_line_height number
Line height. Max: 3
layout.title_space_above string
Space above. Allowed values:
layout.title_space_above_custom number
Custom. Max: 100
layout.subtitle string
layout.subtitle_styling boolean
Change subtitle styles.
layout.subtitle_font font
Subtitle Font.
layout.subtitle_size string
Size. Allowed values:
layout.subtitle_size_custom number
Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3
layout.subtitle_weight string
Weight. Allowed values:
layout.subtitle_color color
Color.
layout.subtitle_line_height number
Line height. Max: 3
layout.subtitle_space_above string
Space above. Allowed values:
layout.subtitle_space_above_custom number
Custom. Max: 100
layout.header_text string
layout.header_text_styling boolean
Styling.
layout.header_text_size string
Size. Allowed values:
layout.header_text_size_custom number
Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3
layout.header_text_weight string
Weight. Allowed values:
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:
layout.header_text_space_above_custom number
Custom. Max: 100
layout.header_border string
Allowed values:
- top (Top)
- bottom (Bottom)
- none (None)
layout.header_border_width number
Width.
layout.header_border_color color
Color.
layout.header_border_style string
Style. Allowed values:
layout.header_border_space number
Space. Space between border and header text
layout.header_logo_enabled boolean
Allowed values:
- true (Enabled)
- false (Disabled)
layout.header_logo_src url
URL.
layout.header_logo_height number
Height.
layout.header_logo_align string
Align. Align logo inside header or outer visualisation container Allowed values:
layout.header_logo_position_inside string
Position. Allowed values:
layout.header_logo_position_outside string
Position. Allowed values:
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.
Footer
layout.footer_align string
Alignment. Allowed values:
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.source_name string
Source name.
layout.source_url string
Source url.
layout.multiple_sources boolean
Multiple sources.
layout.source_name_2 string
Source name.
layout.source_url_2 string
Source url.
layout.source_name_3 string
Source name.
layout.source_url_3 string
Source url.
layout.source_label string
Source label.
layout.footer_note string
Note.
layout.footer_note_secondary string
Note (secondary). The secondary note is placed below the source and primary note
layout.footer_logo_enabled boolean
Image. Allowed values:
layout.footer_logo_src url
Image.
layout.footer_logo_src_light hidden
Image (light version). If provided this version will be used whenever the background colour is dark
layout.footer_logo_link_url string
Link.
layout.footer_logo_height number
Height.
layout.footer_logo_margin number
Margin.
layout.footer_logo_order string
Position. Allowed values:
layout.footer_align_vertical string
V. align. Allowed values:
layout.footer_border string
Allowed values:
- top (Top)
- bottom (Bottom)
- none (None)
layout.footer_border_width number
Width.
layout.footer_border_color color
Color.
layout.footer_border_style string
Style. Allowed values:
layout.footer_border_space number
Space. Space between border and footer text
Accessibility
layout.screenreader_hide_primary boolean
Screenreader mode for main visual container. Whether the main visual container is visible to screenreaders. (Text in the header and footer are always available to screenreaders.) Allowed values:
layout.screenreader_text_primary text
Screenreader description. A text alternative to the visual content that will only be visible to screenreaders, e.g. βThe line chart shows China consistently higher than the other countries since 1990β. Do no replicate your title, since that will also be read by screenreaders.
