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

Template data

There are three different formats in which you can supply data to this template. The most convenient for you to use likely depends on the source of your data, as described below.

1. Array of arrays, and a bindings object

You can supply arrays of arrays to opts.data, which might look like:

{
    data: {
        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: "6",
    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: "6",
    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
            position_x: 4, // index of a column in your data
            position_y: 5, // index of a column in your data
            filter: 6, // index of a column in your data
            photo: 7, // index of a column in your data
            metadata: [8, 9, ...], // 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: "6",
    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: "6",
    bindings: {
        positions: {
            info: ["PositionsHeader1", "PositionsHeader2", ...],
            color: "PositionsHeader3",
            size: "PositionsHeader4",
            position_x: "PositionsHeader5",
            position_y: "PositionsHeader6",
            filter: "PositionsHeader7",
            photo: "PositionsHeader8",
            metadata: ["PositionsHeader9", "PositionsHeader10", ...],
        }
    },
    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: "6",
    data: {
    positions: [
        {
            info: [...],
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/sports",
    version: "6",
    data: {
    positions: [
        {
            info: [...],
            color: ...,
            size: ...,
            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, number
• positions.size: Use this column to adjust the size of the circle number
• 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: metadata string, number, datetime

Template metadata

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: "6",
    ...
    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: "6",
    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

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.

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.

formation string

Formation.

formation_custom code

Custom formation. Use a "*"" for every player and a "-" for every space on the pitch

pitch.margin_top number

Top.

pitch.margin_bottom number

Bottom.

pitch.type string

Sport.

pitch.type_custom string

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

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

pitch.opacity number

Opacity. Opacity of the pitch background

pitch.orientation string

Orientation.

pitch.crop string

Crop pitch. Show the full pitch, or only show a portion

pitch.crop_custom number

Custom.

pitch.flip boolean

Flip.

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. 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:<br /><hr />Party 1: red<br />Party 2: #4455AA<br />Party 3: rgb(30,168,26)

colors.numeric_type string

Scale type.

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.

colors.bin_mode string

Binning mode.

colors.bin_count number

Number of bins.

colors.bin_thresholds string

Custom thresholds. Write your custom thresholds, separated by a ";" For example "5;10;15". Bins are created between the domain minimum and the first threshold, between each threshold and between the final threshold and the domain maximum. Therefore for the example "5;10;15" four bins are created. (The domain is the minimum and maximum values of your data.)

colors.sequential_palette string

Palette.

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.

colors.sequential_custom_domain boolean

Domain.

colors.sequential_domain_min number

Min.

colors.sequential_domain_max number

Max.

colors.diverging_palette string

Palette.

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.

colors.diverging_custom_domain boolean

Domain.

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

dot_size string

Size.

dot_size_custom number

Custom.

dot_border string

Border size.

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

label_color color

Color. Label color. Defaults to layout font color settings if not set.

label_weight string

Weight.

label_size string

Size. Sizing unit is relative to root font size

label_size_custom number

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

image_contrast number

Contrast.

image_brightness number

Brightness.

image_saturation number

Saturation.

image_blend_mode string

Blend mode.

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

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.

trail_color color

Color.

trail_opacity number

Opacity.

trail_size string

Size.

trail_size_custom number

Custom. Proportional to the smallest point size

trail_style string

Style.

Popups & panels

popup.mode string

popup.popup_is_custom boolean

Popup content.

popup.show_popup_styles boolean

Show popup styles.

popup.popup_custom_header html

Popup custom header. 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. You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}}

popup.popup_custom_main html

Popup custom main 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. You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}}

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 <code>aria-label</code> attribute to data point elements. You can still use {{column_name}} to add values from your data, but do not use HTML. For example: <code>{Name}}, Population: {{Population}}, GDP: {{GDP}}</code> 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.

popup.popup_background color

Fill color.

popup.popup_background_opacity number

Fill opacity.

popup.popup_padding number

Padding.

popup.popup_radius number

Radius. Corner radius of popup

popup.popup_header_type string

Header style.

popup.popup_header_background color

Background.

popup.popup_header_text_color color

Text.

popup.popup_list_type string

List type.

popup.popup_list_label_weight string

Label weight.

popup.popup_list_separator string

List separator.

popup.popup_shadow boolean

Shadow.

popup.popup_pointer boolean

Pointer.

popup.panel_position string

popup.panel_open_duration number

Open duration.

popup.panel_side_fixed boolean

Always show.

popup.panel_side_default_content text

Placeholder content.

popup.panel_is_custom boolean

Panel content.

popup.show_panel_styles boolean

Show panel styles.

popup.panel_custom_header html

Panel custom header. The text to appear in the panel. 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. You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}}

popup.panel_custom_main html

Panel custom main content. The text to appear in the panel. 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. You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}}

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 visualisation is really tall, this will make sure the panel content is always on top of the element you've clicked on

popup.panel_text_color color

Text color.

popup.panel_font_size number

Text size.

popup.panel_align string

Alignment.

popup.panel_background color

Fill color.

popup.panel_background_opacity number

Fill opacity.

popup.panel_padding number

Padding.

popup.panel_radius number

Radius. Corner radius of panel

popup.panel_list_type string

List type.

popup.panel_list_label_weight string

Label weight.

popup.panel_list_separator string

List separator.

popup.panel_shadow boolean

Shadow.

Filter controls

controls_container.alignment string

Alignment.

controls_container.controls_spacing number

Spacing. Spacing between individual controls elements (in em) e.g. between a dropdown and an adjcadent set on buttons

filter_control.control_type string

Control type. Choose between a dropdown, buttons or a time slider.

filter_control.control_styles boolean

Adv..

filter_control.control_title string

Control title.

filter_control.button_group boolean

Grouped.

filter_control.button_group_width_mode string

Button group width.

filter_control.button_group_width_fixed number

Width.

filter_control.dropdown_width_mode string

Dropdown width.

filter_control.dropdown_width_fixed number

Width.

filter_control.slider_width number

Slider width. Width of the slider track. In rems, multiples of base font size.

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.

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.

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.

filter_control.sort boolean

Sorting.

controls_style.font_size number

Text size.

controls_style.font_weight string

Text weight.

controls_style.height number

Height.

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

dropdown_style.border_width number

Border width.

dropdown_style.border_color color

Color.

dropdown_style.border_transparency number

Transparency.

dropdown_style.border_radius number

Radius.

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.

button_style.border_color color

Color.

button_style.border_transparency number

Transparency.

button_style.border_radius number

Radius.

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.

slider_style.handle_height number

Height.

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

layout.background_image_enabled boolean

Image.

layout.background_color color

Background color.

layout.background_image_src url

Image URL.

layout.background_image_size string

Size.

layout.background_image_position string

Position.

layout.max_width_target string

Maximum width. Apply a maximum width to just the main graphic or everything (main graphic plus header, footer, etc)

layout.max_width number

Maximum width. Leave blank to stretch to container width

layout.max_width_align string

Align.

layout.layout_order string

Layout order.

layout.space_between_sections string

Space between sections.

layout.space_between_sections_custom number

Custom.

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.

layout.border.top.color color

Color.

layout.border.right.width number

Right.

layout.border.right.style string

Style.

layout.border.right.color color

Color.

layout.border.bottom.width number

Bottom.

layout.border.bottom.style string

Style.

layout.border.bottom.color color

Color.

layout.border.left.width number

Left.

layout.border.left.style string

Style.

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. Its not possible to adjust this on all elements such as axes. Note that when direction is set to "right to left" any alignment icons will be reversed.

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.

layout.title html

layout.title_styling boolean

Styling.

layout.title_font font

Title Font.

layout.title_size string

Size.

layout.title_size_custom number

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

layout.title_weight string

Weight.

layout.title_color color

Color.

layout.title_line_height number

Line height.

layout.title_space_above string

Space above.

layout.title_space_above_custom number

Custom.

layout.subtitle html

layout.subtitle_styling boolean

Styling.

layout.subtitle_font font

Subtitle Font.

layout.subtitle_size string

Size.

layout.subtitle_size_custom number

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

layout.subtitle_weight string

Weight.

layout.subtitle_color color

Color.

layout.subtitle_line_height number

Line height.

layout.subtitle_space_above string

Space above.

layout.subtitle_space_above_custom number

Custom.

layout.header_text html

layout.header_text_styling boolean

Styling.

layout.header_text_size string

Size.

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.

layout.header_text_color color

Color.

layout.header_text_line_height number

Line height.

layout.header_text_space_above string

Space above.

layout.header_text_space_above_custom number

Custom.

layout.header_border string

layout.header_border_width number

Width.

layout.header_border_color color

Color.

layout.header_border_style string

Style.

layout.header_border_space number

Space. Space between border and header text

layout.header_logo_enabled boolean

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 visualisation container

layout.header_logo_position_inside string

Position.

layout.header_logo_position_outside string

Position.

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.

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.

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.

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

layout.footer_align_vertical string

V. align.

layout.footer_border string

layout.footer_border_width number

Width.

layout.footer_border_color color

Color.

layout.footer_border_style string

Style.

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