Sports
Updated 5 months ago to v8.1.2 by Flourish team
How to use this template
What's it for?
Use this template to visualise team line ups on a field or court. You can use it to show a formation, or to map the specific position of players over time
How to get started
- The first thing you need is a CSV or Excel file of your data.
- You need to make sure that there’s a row for each "player" in your team. This should plot the players on the field.
Name Lieke Martens Lionel Messi - Additionally, you can have columns, for the player's team, photo, x and y position, and metadata to show in a popup. It's also possible to add an arbitrary value to size the player's circle, or add a filter.
- Here's an example:
Name Team Photo x y Goals Lieke Martens Barcelona martens.png 45 87 4 Lionel Messi Barcelona messi.png 54 79 9
Not sure how to upload your data to Flourish? See our handy guide
Credits
This template was created by the Flourish team. Want to see additional features? Let us know at support@flourish.studio.
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/sports
version: 8
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: {
positions: [
[ "PositionsColumn1Value1", "PositionsColumn2Value1",
[ "PositionsColumn1Value2", "PositionsColumn2Value2",
[ "PositionsColumn1Value3", "PositionsColumn2Value3",
...
]
}
}
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/sports",
version: "8",
bindings: {
positions: {
}
},
data: {
positions: [
[ "PositionsColumn1Value1", "PositionsColumn2Value1",
[ "PositionsColumn1Value2", "PositionsColumn2Value2",
[ "PositionsColumn1Value3", "PositionsColumn2Value3",
...
]
}
}
All possible bindings that you can supply are shown in this example:
{
template: "@flourish/sports",
version: "8",
bindings: {
positions: {
info: [0, 1, ...], // index(es) of column(s) in your data
color: 2, // index of a column in your data
size: 3, // index of a column in your data
squad_number: 4, // index of a column in your data
position_x: 5, // index of a column in your data
position_y: 6, // index of a column in your data
filter: 7, // index of a column in your data
photo: 8, // index of a column in your data
metadata: [9, 10, ...], // index(es) of column(s) in your data
}
},
data: {
positions: [
[ "PositionsColumn1Value1", "PositionsColumn2Value1",
[ "PositionsColumn1Value2", "PositionsColumn2Value2",
[ "PositionsColumn1Value3", "PositionsColumn2Value3",
...
]
}
}
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:
{
positions: [
{ "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
{ "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
{ "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
...
]
}
... 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/sports",
version: "8",
bindings: {
positions: {
}
},
data: {
positions: [
{ "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
{ "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
{ "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
...
]
}
}
All possible bindings that you can supply are shown in this example:
{
template: "@flourish/sports",
version: "8",
bindings: {
positions: {
info: ["PositionsHeader1", "PositionsHeader2", ...],
color: "PositionsHeader3",
size: "PositionsHeader4",
squad_number: "PositionsHeader5",
position_x: "PositionsHeader6",
position_y: "PositionsHeader7",
filter: "PositionsHeader8",
photo: "PositionsHeader9",
metadata: ["PositionsHeader10", "PositionsHeader11", ...],
}
},
data: {
positions: [
{ "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
{ "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
{ "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
...
]
}
}
(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/sports",
version: "8",
data: {
positions: [
{
info: [...],
metadata: [...]
},
...
]
},
...
}
And the full list of all possible properties is as follows:
{
template: "@flourish/sports",
version: "8",
data: {
positions: [
{
info: [...],
color: ...,
size: ...,
squad_number: ...,
position_x: ...,
position_y: ...,
filter: ...,
photo: ...,
metadata: [...]
},
...
]
},
...
}
Meanings of the template data keys:
- positions.info: For example the player's name string, number
- positions.color: color string
- positions.size: Use this column to adjust the size of the circle number
- positions.squad_number: Optional squad number to appear within circle number, string
- positions.position_x: Use this to move the player to a specific position on the pitch. Make sure to set the player's position setting to "Positions from data" number
- positions.position_y: Use this to move the player to a specific position on the pitch. Make sure to set the player's position setting to "Positions from data" number
- positions.filter: Setting a column here will add a control to the visualization to filter the players. You could use this for example on a time or country column. string, number
- positions.photo: Point to column with image URLs string
- positions.metadata: One or more columns of information to include in popups and panels. 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/sports",
version: "8",
...
data: {
positions: [
[ "PositionsColumn1Value1", "PositionsColumn2Value1",
[ "PositionsColumn1Value2", "PositionsColumn2Value2",
[ "PositionsColumn1Value3", "PositionsColumn2Value3",
...
]
},
metadata: {
positions: {
0: { type: ..., type_id: ..., output_format_id: ... },
1: { type: ..., type_id: ..., output_format_id: ... },
2: { 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/sports",
version: "8",
data: {
positions: [
{ "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
{ "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
{ "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
...
]
},
metadata: {
positions: {
"PositionsHeader1": { type: ..., type_id: ..., output_format_id: ... },
"PositionsHeader2": { type: ..., type_id: ..., output_format_id: ... },
"PositionsHeader3": { 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.
Pitch
positions_type string
Position points by. Position points automatically based on your data, on a specific formation, or use X and Y coordinates Allowed values:
positions_scale_custom string
Position scale. "Auto" will set the position scale based on the minimum and maximum values in your data. "Custom" allows you to set a custom minimum and maximum. Allowed values:
positions_x_min number
X min.
positions_x_max number
X max.
positions_y_min number
Y min.
positions_y_max number
Y max.
formation_type string
Formation type. Allowed values:
formation string
Formation. Allowed values:
formation_custom code
Custom formation. Use a "*"" for every player and a "-" for every space on the pitch
pitch.margin_top number
Top. Increases the gap between the top of the pitch and the first dot Max: 1
pitch.margin_bottom number
Bottom. Increases the gap between the bottom of the pitch and the last dot Max: 1
pitch.type string
Sport. Allowed values:
pitch.type_custom string
Allowed values:
- upload (Upload)
- svg (Write)
pitch.type_upload url
Upload.
pitch.type_svg text
SVG.
pitch.line_color color
Color.
pitch.line_opacity number
Opacity. Opacity of the pitch marking lines Max: 1
pitch.line_width number
Line width. Line width of the pitch markings in pixels
pitch.height number
Pitch height. As a percentage of the width
pitch.background color
Background color. Background color of the pitch. To change the color of the background outside of the pitch, instead slect Background color in the layout section.
pitch.opacity number
Background opacity. Opacity of the pitch background Max: 1
pitch.orientation string
Orientation. Allowed values:
pitch.crop string
Crop pitch. Show the full pitch, or only show a portion Allowed values:
pitch.crop_custom number
Custom. Min: 0.05 Max: 1
pitch.flip_dots boolean
Flip dots. Allowed values:
pitch.flip_pitch boolean
Flip pitch. Allowed values:
Dots
colors.categorical_palette colors
Palette.
colors.categorical_extend boolean
Extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once
colors.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)
colors.numeric_type string
Scale type. Allowed values:
colors.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:
colors.bin_mode string
Binning mode. Allowed values:
colors.bin_count number
Number of bins.
colors.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.
colors.sequential_palette string
Palette. Allowed values:
colors.sequential_reverse boolean
Reverse.
colors.sequential_custom_min color
Minimum color.
colors.sequential_custom_max color
Maximum color.
colors.sequential_color_space string
Color space. Allowed values:
colors.sequential_custom_domain boolean
Domain. Allowed values:
colors.sequential_domain_min number
Min.
colors.sequential_domain_max number
Max.
colors.diverging_palette string
Palette. Allowed values:
colors.diverging_reverse boolean
Reverse.
colors.diverging_custom_min color
Minimum color.
colors.diverging_custom_mid color
Midpoint color.
colors.diverging_custom_max color
Maximum color.
colors.diverging_color_space string
Color space. Allowed values:
colors.diverging_custom_domain boolean
Domain. Allowed values:
colors.diverging_domain_min number
Min.
colors.diverging_domain_mid number
Mid.
colors.diverging_domain_max number
Max.
dot_opacity number
Opacity. Opacity of the dots Max: 1
dot_size string
Size. Allowed values:
dot_size_custom number
Custom. Max: 20
dot_border string
Border size. Allowed values:
dot_border_custom number
Custom.
dot_border_color color
Color. Outline color of the dots
label_mode boolean
Labels. Labels will always be hidden if there are more than 200 data points Allowed values:
label_color color
Color. Label color. Defaults to layout font color settings if not set.
label_weight string
Weight. Allowed values:
label_size string
Size. Sizing unit is relative to root font size Allowed values:
label_size_custom number
Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3 Max: 10
show_squad_numbers boolean
Show Squad Numbers. Optional squad number to appear within dot
squad_number_size string
Size Mode. Resizes the font size as a proportion of the dots radius Allowed values:
squad_number_size_custom number
Custom. Specify a custom responsive font size. Best results are betwen 0.8 and 2. Max: 10
squad_number_weight string
Weight. Allowed values:
squad_number_color color
Color.
squad_number_vertical_adjust number
Adjust vertical spacing. Adjust vertical centering for custom fonts Min: -1 Max: 1
image_contrast number
Contrast.
image_brightness number
Brightness.
image_saturation number
Saturation. Max: 1
image_blend_mode string
Blend mode. Allowed values:
Animation & trail lines
animation_target string
Animate. Choose whether you want to animate the animate the positions or fade, for example when changing the filter, or drag players' positions in the story editor Allowed values:
animation_duration number
Duration. Specified in seconds
trail boolean
Trail lines. Show trail lines when a point is dragged to a new position. Only visible in the story editor. Allowed values:
trail_color color
Color.
trail_opacity number
Opacity. Max: 1
trail_size string
Size. Allowed values:
trail_size_custom number
Custom. Proportional to the smallest point size Max: 1
trail_style string
Style. Allowed values:
Legend
legend_categorical.show_legend boolean
Allowed values:
- true (Enabled)
- false (Disabled)
legend_categorical.title_mode string
Title mode. Allowed values:
legend_categorical.title string
Title.
legend_categorical.swatch_width number
Width.
legend_categorical.swatch_height number
Height.
legend_categorical.swatch_radius number
Roundness. The radius of the corners of the swatch (in pixels)
legend_categorical.legend_items_padding number
Padding. Padding between legend items (in rems)
legend_categorical.swatch_outline boolean
Outline. An optional outline for the swatch in the legend
legend_categorical.swatch_outline_color color
Color.
legend_categorical.order_override text
Custom order override. Manually specify the order of legend entries (one entry per line)
legend_categorical.icon_height number
Height. Height of icon (in rems)
legend_categorical.icon_color color
Color. Fallback color (icon color if not determined by template)
legend_categorical.max_width number
Max width.
legend_categorical.orientation string
Orientation. Allowed values:
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
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 controls
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
filter_control.control_type string
Control type. Choose between a dropdown, buttons or a time slider. Allowed values:
filter_control.control_styles boolean
Adv..
filter_control.control_title string
Control title.
filter_control.button_group boolean
Grouped. Allowed values:
filter_control.button_group_width_mode string
Button group width. Allowed values:
filter_control.button_group_width_fixed number
Width. Max: 100
filter_control.dropdown_width_mode string
Dropdown width. Allowed values:
filter_control.dropdown_width_fixed number
Width. Max: 100
filter_control.slider_width number
Slider width. Width of the slider track in rems Max: 100
filter_control.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_control.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_control.slider_loop boolean
Loop.
filter_control.slider_restart_pause number
Pause before loop. Measured in seconds and in addition to the regular step time displayed above Max: 100
filter_control.sort boolean
Sorting. Allowed values:
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.
filter_include_all boolean
Include "all". Include "All" in the filter dropdown
filter_all_label string
All label.
Layout
Layout
layout.body_font font
Main font. This font will apply to the whole graphic by default. You can optionally change the font for the title, subtitle, footer, etc in the Header and Footer settings panels.
layout.font_color color
Text color. This color will apply to the whole graphic by default, You can optionally change the color for individual text elements, in other settings panels.
layout.background_color_enabled boolean
Color. Allowed values:
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.
layout.footer_note_secondary html
Note (secondary). The secondary note is placed below the source and primary note
layout.footer_logo_enabled boolean
Image. Allowed values:
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:
