Scatter
Updated 3 months ago to v23.0.0 by Flourish team
How to use this template
Scatter
A template for creating two-dimensional scatter plots, ideal for showing correlation, trends and outliers. Extra information can be encoded using colour, shape and size, and data can be divided (or “faceted”) into multiple smaller datasets using the “Grid of charts” feature.
Data requirements
To make a simple scatter chart, all you need is two columns of data: one for the x (horizontal) axis and one for the y (vertical) axis. Each row is plotted as a “dot”, and the spread of dots on the chart shows the relationship between the two metrics. Addition columns can be used to set the colour, size and shape of the dots, or to create interactive controls and custom popups.
Showing change over time
If your data has a column with years or dates, you can create an animated scatter showing change over time, as popularised by Hans Rosling’s famous TED talks. Select a “Time” column to create a slider and choose one or more “Name” columns so the template knows which rows represent the same thing. Rows with the same name will be animated through time and also joined together with lines (which can styled or turned off in the settings panel).
Tips
- Overwhelmed by the number of points? Choose a “Filter” column to create a menu to switch between subsets of the data.
- Want to compare subsets alongside each other? Select a “Grid of charts” column to create an array of mini charts.
- Want to show a custom popup? You can include as many “Info” columns as you like, and advanced users can even use HTML and CSS to pull in pictures from a column of image URLs.
- Try making a Flourish story to guide an audience through different views of your scatter visualisation.
Credits
The default data comes from the World Bank and is licensed under CC-BY 4.0.
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/scatter
version: 23
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/scatter",
version: "23",
bindings: {
data: {
}
},
data: {
data: [
[ "DataColumn1Value1", "DataColumn2Value1",
[ "DataColumn1Value2", "DataColumn2Value2",
[ "DataColumn1Value3", "DataColumn2Value3",
...
]
}
}
All possible bindings that you can supply are shown in this example:
{
template: "@flourish/scatter",
version: "23",
bindings: {
data: {
x: 0, // index of a column in your data
y: 1, // index of a column in your data
name: [2, 3, ...], // index(es) of column(s) in your data
color: 4, // index of a column in your data
size: 5, // index of a column in your data
shape: 6, // index of a column in your data
facet: 7, // index of a column in your data
slider: 8, // index of a column in your data
series: 9, // index of a column in your data
filter: 10, // index of a column in your data
metadata: [11, 12, ...], // 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/scatter",
version: "23",
bindings: {
data: {
}
},
data: {
data: [
{ "DataHeader1": ..., "DataHeader2": ..., ... },
{ "DataHeader1": ..., "DataHeader2": ..., ... },
{ "DataHeader1": ..., "DataHeader2": ..., ... },
...
]
}
}
All possible bindings that you can supply are shown in this example:
{
template: "@flourish/scatter",
version: "23",
bindings: {
data: {
x: "DataHeader1",
y: "DataHeader2",
name: ["DataHeader3", "DataHeader4", ...],
color: "DataHeader5",
size: "DataHeader6",
shape: "DataHeader7",
facet: "DataHeader8",
slider: "DataHeader9",
series: "DataHeader10",
filter: "DataHeader11",
metadata: ["DataHeader12", "DataHeader13", ...],
}
},
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/scatter",
version: "23",
data: {
data: [
{
name: [...],
metadata: [...]
},
...
]
},
...
}
And the full list of all possible properties is as follows:
{
template: "@flourish/scatter",
version: "23",
data: {
data: [
{
x: ...,
y: ...,
name: [...],
color: ...,
size: ...,
shape: ...,
facet: ...,
slider: ...,
series: ...,
filter: ...,
metadata: [...]
},
...
]
},
...
}
Meanings of the template data keys:
- data.x: x number, string, datetime
- data.y: y number, string, datetime
- data.name: Select multiple columns if required to make a unique name. string
- data.color: Colors the dots based on numbers or categories string, number
- data.size: Sizes the dots based on the numbers number, string
- data.shape: <a href="https://helpcenter.flourish.studio/hc/en-us/articles/8761582553487-How-to-override-the-shape-order-of-the-Scatter-plot">Sets the shape</a> of the dots based on numbers or categories string
- data.facet: Creates a <a href="https://help.flourish.studio/article/266-how-to-create-a-grid-of-charts#creating-grid-scatter">mini chart</a> for each value in the selected column string
- data.slider: Creates a time slider and connects/animates dots with the same name datetime, string, number
- data.series: Group dots into series based on the contents of a column string
- data.filter: Creates a <a href="https://help.flourish.studio/article/107-how-to-create-a-scatter-plot-with-a-filter">control</a> based on the contents of any column string, number, datetime
- data.metadata: One or more columns of information (text, <a href="https://help.flourish.studio/article/46-how-to-add-images-to-your-visualization">image URLs</a>, <a href="https://help.flourish.studio/article/259-how-to-embed-charts-in-your-popups-or-panels">embedded charts</a> etc) to include in <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups">popups and panels</a>. 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/scatter",
version: "23",
...
data: {
data: [
[ "DataColumn1Value1", "DataColumn2Value1",
[ "DataColumn1Value2", "DataColumn2Value2",
[ "DataColumn1Value3", "DataColumn2Value3",
...
]
},
metadata: {
data: {
0: { type: ..., type_id: ..., output_format_id: ... },
1: { 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/scatter",
version: "23",
data: {
data: [
{ "DataHeader1": ..., "DataHeader2": ..., ... },
{ "DataHeader1": ..., "DataHeader2": ..., ... },
{ "DataHeader1": ..., "DataHeader2": ..., ... },
...
]
},
metadata: {
data: {
"DataHeader1": { type: ..., type_id: ..., output_format_id: ... },
"DataHeader2": { 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.
Dot styles
default_color color
Default color. Used when Color column is unspecified
fill_opacity number
Dot opacity. Max: 1
default_shape string
Default shape. Used when Shape column is unspecified or empty Allowed values:
data_point_default_size number
Size. In pixel area. Only used when Size column is unspecified or empty. Subject to scaling with the chart size (see setting below). Min: 1
data_point_min_size number
Min size. In pixel area. Used when you have a Size column selected. Subject to scaling with the chart size.
data_point_max_size number
Max size. In pixel area. Used when you have a Size column selected. Subject to scaling with the chart size.
responsive_dots boolean
Scale dots based on chart size. Makes the dots get bigger or smaller relative to the chart size. Turn off to specify a fixed size regardless of chart size.
stroke_opacity number
Outline opacity. Max: 1
stroke_width number
Outline width.
stroke_mode string
Outline mode. Choose Auto for outline color to match dot color. Choose Fixed to give all dots a uniform outline color. Allowed values:
stroke_color color
Outline color.
render_mode string
Renderer. In most cases you should only need SVG, but you may want to choose WebGL if you have a lot of data or you notice your chart is running slowly on your device. Allowed values:
Dot colors
color.categorical_palette colors
Palette.
color.categorical_extend boolean
Extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once
color.categorical_custom_palette text
Custom overrides. 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:
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. Enter your desired thresholds, separating them with a ";". For instance, "5;10;15".
Bins form as follows:
For "5;10;15", you'll get four bins based on your data's range.
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.
Dot labels
labels_show boolean
Show labels on points. Labels only show up if you have designated a Name column in the data tab
labels_selective boolean
Label mode. To show labels selectively, turn on this option and then make a story. In the story editor, click on dots to hide/show the labels. Allowed values:
label_priority_list text
Label priority. Specify the prority with which labels should be drawn. For example:
London
New York
Beijing
label_hide_list text
Hide labels. Specify labels which should be hidden. For example:
Paris
Madrid
hide_non_prioritized_labels boolean
Only show labels on 'Label priority' list. If true, only the labels on the priority list will be drawn.
label_hide_overlapping boolean
Hide overlapping labels.
label_position string
Label position. Choose to position labels around data points or, where labels fit, position them inside data points. Allowed values:
label_font_size_min number
Min font size.
label_font_size_max number
Max font size.
label_max_width number
Max width.
label_align string
Alignment. Align the text at the start, middle or end of the data point. Allowed values:
label_x_offset string
Offset. Place labels on top of or next to the data point Allowed values:
label_y_offset string
Offset. Place labels on top of or next to the data point Allowed values:
label_weight string
Weight. Allowed values:
label_color_type string
Label color. Allowed values:
label_color color
Fixed.
label_outline boolean
Outline.
label_outline_color color
Color.
Chart set-up
height_mode string
Sizing mode. In Fill space mode the graphic will fill the container (which by default will be the the standard Flourish responsive chart size). Allowed values:
In Aspect ratio mode, you set the aspect ratio of the plot, and the container will be updated to accommodate it (not supported when embedded in a simple fixed-height iframe).
facet_aspect number
Aspect (desktop). Aspect ratio of each plot in desktop mode, where 1 is square, above 1 is wider, and below 1 is taller. Min: 0.01 Max: 100
facet_aspect_mobile number
Aspect (mobile). Aspect of each plot in mobile mode, where 1 is square, above 1 is wider, and below 1 is taller. Min: 0.01 Max: 100
chart_bg.background_color_enabled boolean
Color. Allowed values:
chart_bg.background_image_enabled boolean
Image. Allowed values:
chart_bg.background_color color
Color.
chart_bg.background_image_src url
Image URL.
chart_bg.background_image_size string
Size. Allowed values:
chart_bg.background_image_position string
Position. Allowed values:
margin_top number
Top.
margin_right number
Right.
margin_bottom number
Bottom.
margin_left number
Left.
Grid of charts
facet_fixed_cols boolean
Fixed number of columns in grid.
facet_min_w number
Min chart width. Determines how many columns of charts there should be in the grid. Ignored if you specify a fixed number of columns.
facet_cols number
Number of columns in grid. Min: 1
facet_gutter_w number
Horizontal. In rems
facet_gutter_h number
Vertical. In rems
facet_header_font_size number
Text size. In rems
facet_title_align string
Alignment. Allowed values:
facet_header_color color
Color.
Lines & arrows
lines_show boolean
Shows lines.
line_width number
Line width. In rems, a multiple of the page's base font size
line_curve string
Line style. Allowed values:
line_opacity number
Line opacity. Max: 1
line_color_mode string
Line color. When set to Match dots the lines will be the same as the first dot in the line Allowed values:
line_per_facet boolean
Lock lines to axes. Disable to allow lines to run between or animate between facets
line_color color
Color.
line_arrows boolean
Arrow heads on lines.
line_arrow_size number
Size.
line_arrow_color_mode string
Color mode. Allowed values:
line_arrow_color color
Color.
X axis
x_matching boolean
Matching x axis across grid of charts.
x_single_row boolean
Only show x axis on first column of grid.
x.axis_position string
Position. Allowed values:
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:
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:
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:
x.title_mode string
Type. Allowed values:
x.title string
Text.
x.title_styling boolean
Styling.
x.title_weight string
Weight. Allowed values:
x.title_color color
Color.
x.title_size number
Size.
x.title_padding number
Padding.
x.tick_label_position string
Position. Allowed values:
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:
x.tick_label_weight string
Weight. Allowed values:
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:
x.tick_label_space number
Space.
x.tick_mode string
Mode. Sets the method for selecting tick values on the axis: Allowed values:
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.
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:
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:
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.
x_formatting.prefix string
Prefix. Text to place in front of a number
x_formatting.suffix string
Suffix. Text to place after a number
x_formatting.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
x_formatting.advanced boolean
Advanced.
x_formatting.negative_sign string
Styling of negative numbers. Allowed values:
x_formatting.strip_zeros boolean
Remove trailing zeros.
x_formatting.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”.
x_formatting.transform_labels boolean
Multiply/divide values.
x_formatting.transform string
Allowed values:
- multiply (Multiply by)
- divide (Divide by)
- exponentiate (×10 to the power of)
x_formatting.multiply_divide_constant number
x_formatting.exponentiate_constant number
Y axis
y_matching boolean
Matching y axis across grid of charts.
y_single_col boolean
Only show Y axis on first column of grid.
y.axis_visible boolean
Allowed values:
- true (Axis visible)
- false (Axis hidden)
y.numeric_scale_type string
Type. Allowed values:
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:
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:
y.title_mode string
Type. Allowed values:
y.title string
Text.
y.title_styling boolean
Styling.
y.title_position string
Position. Allowed values:
y.title_weight string
Weight. Allowed values:
y.title_color color
Color.
y.title_size number
Size.
y.title_padding number
Padding.
y.tick_label_position string
Position. Allowed values:
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:
y.tick_label_weight string
Weight. Allowed values:
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:
y.tick_label_space number
Space.
y.tick_mode string
Mode. Sets the method for selecting tick values on the axis: Allowed values:
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.
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:
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:
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
y_formatting.prefix string
Prefix. Text to place in front of a number
y_formatting.suffix string
Suffix. Text to place after a number
y_formatting.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
y_formatting.advanced boolean
Advanced.
y_formatting.negative_sign string
Styling of negative numbers. Allowed values:
y_formatting.strip_zeros boolean
Remove trailing zeros.
y_formatting.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”.
y_formatting.transform_labels boolean
Multiply/divide values.
y_formatting.transform string
Allowed values:
- multiply (Multiply by)
- divide (Divide by)
- exponentiate (×10 to the power of)
y_formatting.multiply_divide_constant number
y_formatting.exponentiate_constant number
Legend
legend_position string
Legend position. The legend position relative to the chart. A legend will not show with a single entry. Allowed values:
legend_filtering_mode string
Clickable legend. When a legend item is clicked on, the corresponding dots can either be hidden or shown. This option can also be turned off. Allowed values:
legend_container.alignment string
Alignment. Allowed values:
legend_container.orientation string
Orientation. Allowed values:
legend_container.title_weight string
Title weight. Allowed values:
legend_container.text_weight string
Text weight. Allowed values:
legend_container.text_color color
Color.
legend_container.text_size number
Size. Max: 10
categorical_legend.show_legend boolean
Legend mode. A legend will not show with a single entry Allowed values:
categorical_legend.title_mode string
Title mode. Allowed values:
categorical_legend.title string
Title.
categorical_legend.swatch_width number
Width.
categorical_legend.swatch_height number
Height.
categorical_legend.swatch_radius number
Roundness. The radius of the corners of the swatch (in pixels)
categorical_legend.legend_items_padding number
Padding. Padding between legend items (in rems)
categorical_legend.swatch_outline boolean
Outline. An optional outline for the swatch in the legend
categorical_legend.swatch_outline_color color
Color.
categorical_legend.order_override text
Custom order override. Manually specify the order of legend entries (one entry per line)
categorical_legend.icon_height number
Height. Height of icon (in rems)
categorical_legend.icon_color color
Color. Fallback color (icon color if not determined by template)
categorical_legend.max_width number
Max width.
categorical_legend.orientation string
Orientation. Allowed values:
continuous_legend.show_legend boolean
Allowed values:
- true (Enabled)
- false (Disabled)
continuous_legend.title_mode string
Title mode. Allowed values:
continuous_legend.title string
Title.
continuous_legend.color_band_width number
Width.
continuous_legend.color_band_height number
Height.
continuous_legend.color_band_radius number
Roundness. The radius of the corners of the color band (in pixels)
continuous_legend.binned_label_mode string
Binned label mode. Allowed values:
continuous_legend.binned_label_custom string
Custom bin labels. List numeric values, separated by semi-colons.
continuous_legend.legend_min number
Legend min.
continuous_legend.additional_min_label string
Custom min label.
continuous_legend.legend_max number
Legend max.
continuous_legend.additional_max_label string
Custom max label.
text_legend string
Allowed values:
- auto (Auto)
- custom (Custom)
- off (Off)
text_legend_title boolean
Title.
text_legend_subtitle boolean
Subtitle.
text_legend_bold boolean
Bold. If checked, always use bold for colored items
color_formatting.prefix string
Prefix. Text to place in front of a number
color_formatting.suffix string
Suffix. Text to place after a number
color_formatting.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
color_formatting.advanced boolean
Advanced.
color_formatting.negative_sign string
Styling of negative numbers. Allowed values:
color_formatting.strip_zeros boolean
Remove trailing zeros.
color_formatting.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”.
color_formatting.transform_labels boolean
Multiply/divide values.
color_formatting.transform string
Allowed values:
- multiply (Multiply by)
- divide (Divide by)
- exponentiate (×10 to the power of)
color_formatting.multiply_divide_constant number
color_formatting.exponentiate_constant number
Popups & panels
popup.mode string
Allowed values:
- none (None)
- popup (Popup)
- panel (Panel)
- both (Both)
popup.popup_is_custom boolean
Popup content. Allowed values:
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:
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:
popup.popup_header_background color
Background.
popup.popup_header_text_color color
Text.
popup.popup_list_type string
List type. Allowed values:
popup.popup_list_label_weight string
Label weight. Allowed values:
popup.popup_list_separator string
List separator. Predefined values:
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:
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:
popup.panel_text_color color
Text color.
popup.panel_font_size number
Text size.
popup.panel_align string
Alignment. Allowed values:
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:
popup.panel_list_label_weight string
Label weight. Allowed values:
popup.panel_list_separator string
List separator. Predefined values:
popup.panel_shadow boolean
Shadow.
Filter
filter.control_type string
Control type. Choose between a dropdown, buttons or a time slider. Allowed values:
filter.control_styles boolean
Adv..
filter.control_title string
Control title.
filter.button_group boolean
Grouped. Allowed values:
filter.button_group_width_mode string
Button group width. Allowed values:
filter.button_group_width_fixed number
Width. Max: 100
filter.dropdown_width_mode string
Dropdown width. Allowed values:
filter.dropdown_width_fixed number
Width. Max: 100
filter.slider_width number
Slider width. Width of the slider track in rems Max: 100
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
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
filter.slider_loop boolean
Loop.
filter.slider_restart_pause number
Pause before loop. Measured in seconds and in addition to the regular step time displayed above Max: 100
filter.sort boolean
Sorting. Allowed values:
filter_show_all boolean
Include "All".
filter_show_all_text string
“All” label.
filter_updates_axes string
Update axes when filtering. Allowed values:
Time slider
slider_updates_axes string
Update axes when using slider. Allowed values:
time_label_show boolean
Show time label.
time_label_color color
Color.
time_label_opacity number
Opacity. Max: 1
time_label_font_size number
Size. As a percent of the default size; the actual size scales with the chart
slider.control_type string
Control type. Choose between a dropdown, buttons or a time slider. Allowed values:
slider.control_styles boolean
Adv..
slider.control_title string
Control title.
slider.button_group boolean
Grouped. Allowed values:
slider.button_group_width_mode string
Button group width. Allowed values:
slider.button_group_width_fixed number
Width. Max: 100
slider.dropdown_width_mode string
Dropdown width. Allowed values:
slider.dropdown_width_fixed number
Width. Max: 100
slider.slider_width number
Slider width. Width of the slider track in rems Max: 100
slider.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
slider.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
slider.slider_loop boolean
Loop.
slider.slider_restart_pause number
Pause before loop. Measured in seconds and in addition to the regular step time displayed above Max: 100
slider.sort boolean
Sorting. Allowed values:
Controls style
controls_container.alignment string
Alignment. Allowed values:
controls_container.controls_spacing number
Spacing. The space between controls, like dropdowns and adjacent button sets, in em units. Max: 5
controls_style.font_size number
Text size. Max: 5
controls_style.font_weight string
Text weight. Allowed values:
controls_style.height number
Height. Max: 5
dropdown_style.background color
Background.
dropdown_style.font_color color
Text color.
dropdown_style.border_styles_advanced boolean
Dropdown border styles.
dropdown_style.border_style string
Border style. Show border on all sides, or only at the bottom Allowed values:
dropdown_style.border_width number
Border width. Max: 20
dropdown_style.border_color color
Color.
dropdown_style.border_transparency number
Transparency. Max: 1
dropdown_style.border_radius number
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.
Trend lines
fit_type string
Lines to show. Allowed values:
fit_force_origin boolean
Force line through origin.
fit_line_width number
Width.
fit_line_dash number
Dash.
fit_line_color color
Color.
Box, violin and beeswarm plots
beeswarm_plot boolean
Show beeswarm when plotting one numerical and one categorical axis. Auto mode will make a beeswarm unless there are more than 5000 points in the dataset. Allowed values:
Note: Performance will be reduced with thousands of rows due to the nature of how beeswarm positions are computed.
box_plot boolean
Show box plot when plotting one numerical and one categorical axis. To learn more about box plots <a href="see here Allowed values:
box_color color
Box color.
box_opacity number
Box opacity. Max: 1
box_line_color color
Line color.
box_line_width number
Line width.
box_whisker_type string
Whisker type. Allowed values:
box_whisker_multiplier number
Max whisker length (number of IQR's). Maximum distance whiskers should extend out from the box as a multiple of the interquartile range. 1.5 is John Tukey's classsic value
use_box_popup boolean
Box popup. If enabled, shows a popup for the box describing the first quartile, median, and third quartile. The user will not be able to access the popups for the points underneath the box.
box_first_quartile_text string
First quartile.
box_median_text string
Median.
box_third_quartile_text string
Third quartile.
violin_plot boolean
Show violin plot when plotting one numerical and one categorical axis. To learn more about violin plots <a href="see here Allowed values:
violin_bandwidth number
Bandwidth. The bandwidth in a violin plot determines the degree of smoothing applied to the probability density function estimating the shape of the plot.
Generally, larger bandwidth values create a smoother plot with less detail, while smaller values create a more precise plot with more detail.
violin_samples number
No. of samples. Number of points at which to calculate a violin's distribution. More points means a more accurate curve but can also harm performance. Min: 10 Max: 250
violin_color color
Color.
violin_opacity number
Opacity. Max: 1
violin_sizing string
Sizing mode. Allowed values:
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:
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:
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:
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:
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:
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:
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:
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:
axes_highlights.y_label_color color
Text.
axes_highlights.y_shadow_color color
Shadow.
axes_highlights.y_shadow_enabled boolean
Shadow.
annotations_styling boolean
Show annotations styling.
annotations.defaults.text_weight string
Weight. Allowed values:
annotations.defaults.text_size number
Text size.
annotations.defaults.text_color color
Text color.
annotations.defaults.label_width number
Max width. Min: 2 Max: 20
annotations.defaults.text_background_mode string
Text background. Allowed values:
annotations.defaults.text_bg color
Outline.
annotations.defaults.label_bg color
Background.
annotations.defaults.text_alignment string
Alignment. Allowed values:
annotations.defaults.popup_position string
Popup position. Allowed values:
annotations.defaults.line_marker string
Marker. Allowed values:
annotations.defaults.stroke_width number
Width. Max: 4
annotations.defaults.stroke_color color
Color.
annotations.defaults.connector_extend_line string
Extend line. Allowed values:
Animations
animation_duration number
Animation duration. The duration of the animation for each dot or axis, in seconds. The animation can be seen between slides in a Flourish story.
animation_stagger number
Animation stagger. The delay between each dot starting to move, in seconds; set to 0 to have all dots move simultaneously
line_animate_in boolean
Animate new lines in. Whether new lines should appear whole or be animated into view
line_animate_out boolean
Animate exiting lines. Whether filtered/removed lines should be removed whole or animated out of view
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:
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.
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. Allowed values:
Note that when direction is set to right to left any alignment icons will be reversed.
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
Header
layout.header_align string
Alignment. Allowed values:
layout.title html
layout.title_styling boolean
Styling.
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 in rems. The 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 html
layout.subtitle_styling boolean
Styling.
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 in rems. The 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 html
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 in rems. The 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)
- 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:
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.
layout.header_logo_link_url string
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:
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.footer_text_weight string
Weight. Allowed values:
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. Predefined values:
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 color is dark
layout.footer_logo_alt string
Alt text.
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)
- 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:
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:
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.
