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: {
        players: [
            [ "PlayersColumn1Value1", "PlayersColumn2Value1",
            [ "PlayersColumn1Value2", "PlayersColumn2Value2",
            [ "PlayersColumn1Value3", "PlayersColumn2Value3",
            ...
        ]
    }
}

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: "5",
    bindings: {
        players: {
            
        }
    },
    data: {
        players: [
            [ "PlayersColumn1Value1", "PlayersColumn2Value1",
            [ "PlayersColumn1Value2", "PlayersColumn2Value2",
            [ "PlayersColumn1Value3", "PlayersColumn2Value3",
            ...
        ]
    }
}

All possible bindings that you can supply are shown in this example:

{
    template: "@flourish/sports",
    version: "5",
    bindings: {
        players: {
            info: [0, 1, ...], // index(es) of column(s) in your data
            team: 2, // index of a column in your data
            category: 3, // index of a column in your data
            size: 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: {
        players: [
            [ "PlayersColumn1Value1", "PlayersColumn2Value1",
            [ "PlayersColumn1Value2", "PlayersColumn2Value2",
            [ "PlayersColumn1Value3", "PlayersColumn2Value3",
            ...
        ]
    }
}

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:

{
        players: [
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            ...
        ]
    }

... 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: "5",
    bindings: {
        players: {
            
        }
    },
    data: {
        players: [
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            ...
        ]
    }
}

All possible bindings that you can supply are shown in this example:

{
    template: "@flourish/sports",
    version: "5",
    bindings: {
        players: {
            info: ["PlayersHeader1", "PlayersHeader2", ...],
            team: "PlayersHeader3",
            category: "PlayersHeader4",
            size: "PlayersHeader5",
            position_x: "PlayersHeader6",
            position_y: "PlayersHeader7",
            filter: "PlayersHeader8",
            photo: "PlayersHeader9",
            metadata: ["PlayersHeader10", "PlayersHeader11", ...],
        }
    },
    data: {
        players: [
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            ...
        ]
    }
}

(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: "5",
    data: {
    players: [
        {
            info: [...],
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/sports",
    version: "5",
    data: {
    players: [
        {
            info: [...],
            team: ...,
            category: ...,
            size: ...,
            position_x: ...,
            position_y: ...,
            filter: ...,
            photo: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

• players.info: eg. the player's name
• players.team: Used to set fill color for each dot
• players.category: Used to set stroke color for each dot
• players.size: Use this column to adjust the size of the circle
• players.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"
• players.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"
• players.filter: Setting a column here will add a control to the visualisation to filter the players. You could use this for example on a time or country column.
• players.photo: Point to column with image urls
• players.metadata: metadata

Template settings

Options for opts.state.

Players

positions_type string

Players position. Position players based on a specific formation, or use x and y coordinates for players if you have the data

positions_reverse boolean

Start formation.

positions_scale_custom boolean

Position scale.

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

pitch.background color

Background.

aspect_ratio number

Aspect ratio.

pitch.offset number

Offset.

pitch.margin_top number

Top margin.

pitch.margin_bottom number

Bottom margin.

pitch.type string

Type.

pitch.line_color color

Color.

pitch.line_width number

Width.

pitch.type_custom string

pitch.type_upload url

Upload.

pitch.type_svg text

SVG.

pitch.rotation_x number

X Rotation.

pitch.rotation_z number

Z Rotation.

pitch.shadow number

Shadow.

Dots

label_size number

Label size.

label_color color

Color.

label_weight string

Weight.

label_offset number

Label vertical offset.

dot_size number

Size. As percentage of the pitch width

colors_team_single color

Color.

dot_opacity number

Opacity.

colors_team.scale_type string

Scale type.

colors_team.categorical_palette colors

Palette.

colors_team.categorical_extend boolean

Extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once.

colors_team.categorical_custom_palette text

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

---

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

colors_team.numeric_type string

Scale type.

colors_team.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_team.bin_mode string

Binning mode.

colors_team.bin_count number

Number of bins.

colors_team.bin_thresholds string

Custom thresholds. Write your custom thresholds, separated by a ";" For example 5;10;15

colors_team.sequential_palette string

Palette.

colors_team.sequential_reverse boolean

Reverse.

colors_team.sequential_custom_min color

Minimum color.

colors_team.sequential_custom_max color

Maximum color.

colors_team.sequential_color_space string

Color space.

colors_team.sequential_custom_domain boolean

Domain.

colors_team.sequential_domain_min number

Min.

colors_team.sequential_domain_max number

Max.

colors_team.diverging_palette string

Palette.

colors_team.diverging_reverse boolean

Reverse.

colors_team.diverging_custom_min color

Minimum color.

colors_team.diverging_custom_mid color

Midpoint color.

colors_team.diverging_custom_max color

Maximum color.

colors_team.diverging_color_space string

Color space.

colors_team.diverging_custom_domain boolean

Domain.

colors_team.diverging_domain_min number

Min.

colors_team.diverging_domain_mid number

Mid.

colors_team.diverging_domain_max number

Max.

dot_border number

Width.

colors_category_single color

Color.

colors_category.scale_type string

Scale type.

colors_category.categorical_palette colors

Palette.

colors_category.categorical_extend boolean

Extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once.

colors_category.categorical_custom_palette text

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

---

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

colors_category.numeric_type string

Scale type.

colors_category.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_category.bin_mode string

Binning mode.

colors_category.bin_count number

Number of bins.

colors_category.bin_thresholds string

Custom thresholds. Write your custom thresholds, separated by a ";" For example 5;10;15

colors_category.sequential_palette string

Palette.

colors_category.sequential_reverse boolean

Reverse.

colors_category.sequential_custom_min color

Minimum color.

colors_category.sequential_custom_max color

Maximum color.

colors_category.sequential_color_space string

Color space.

colors_category.sequential_custom_domain boolean

Domain.

colors_category.sequential_domain_min number

Min.

colors_category.sequential_domain_max number

Max.

colors_category.diverging_palette string

Palette.

colors_category.diverging_reverse boolean

Reverse.

colors_category.diverging_custom_min color

Minimum color.

colors_category.diverging_custom_mid color

Midpoint color.

colors_category.diverging_custom_max color

Maximum color.

colors_category.diverging_color_space string

Color space.

colors_category.diverging_custom_domain boolean

Domain.

colors_category.diverging_domain_min number

Min.

colors_category.diverging_domain_mid number

Mid.

colors_category.diverging_domain_max number

Max.

image_styles_enabled boolean

image_contrast number

Contrast.

image_brightness number

Brightness.

image_saturation number

Saturation.

image_blend_mode string

Blend mode.

animation_target string

Animate.

animation_duration number

Duration.

Popups

popup.show_popups boolean

Popups.

popup.is_custom boolean

Popup contents.

popup.custom_template text

Popup content. The text to appear in the popup. You can use {{column_name}} to add a value from your data. It must be in a selected column, but you can add columns to “Metadata” if you just want to include them for use in the popup. Advanced users can include HTML to apply layouts, formatting, images, etc.

popup.show_pointer boolean

Pointer.

popup.show_shadow boolean

Shadow.

popup.style_popups boolean

Custom styling.

popup.text_color color

Text colour.

popup.align string

Alignment.

popup.font_size number

Font size.

popup.fill_color color

Fill colour.

popup.opacity number

Fill opacity.

popup.padding number

Padding.

popup.border_radius number

Radius. Corner radius of popup

Filter controls

filter_control.type string

Data type.

filter_control.temporal_format string

Date/time format in data. The date/time format in your data sheet. Used only to sort the data, if required. If your format isn’t in the list, you can enter a custom format using d3-time-format syntax. See npmjs.com/package/d3-time-format for details.

filter_control.sort boolean

Sort menu.

filter_control.control string

Control.

filter_control.width number

Menu width.

filter_control.play_button boolean

Include play button.

filter_control.step_time number

Time between steps when playing. Measured in seconds, positive values move the slider left to right, negative values move the slider right to left.

filter_control.loop boolean

Loop on play.

filter_control.restart_pause number

Pause before loop restarts. Measured in seconds and in addition to the regular step time displayed above.

filter_control.dropdown_icon_color color

Icon color.

filter_control.slider_handle_color color

Handle and button color.

filter_control.slider_track_color color

Track and label color.

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.

Header

layout.header_align string

Alignment.

layout.title string

layout.title_styling boolean

Change title styles.

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 string

layout.subtitle_styling boolean

Change subtitle styles.

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 string

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

URL.

layout.header_logo_height number

Height.

layout.header_logo_align string

Align. Align logo inside header or outer 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.source_name string

Source name.

layout.source_url string

Source url.

layout.multiple_sources boolean

Multiple sources.

layout.source_name_2 string

Source name.

layout.source_url_2 string

Source url.

layout.source_name_3 string

Source name.

layout.source_url_3 string

Source url.

layout.source_label string

Source label.

layout.footer_note string

Note.

layout.footer_note_secondary string

Note (secondary). The secondary note is placed below the source and primary note

layout.footer_logo_enabled boolean

Image.

layout.footer_logo_src url

Image.

layout.footer_logo_src_light hidden

Image (light version). If provided this version will be used whenever the background colour is dark

layout.footer_logo_link_url string

Link.

layout.footer_logo_height number

Height.

layout.footer_logo_margin number

Margin.

layout.footer_logo_order string

Position.

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

layout.screenreader_text_primary text

Screenreader description. A text alternative to the visual content that will only be visible to screenreaders, e.g. “The line chart shows China consistently higher than the other countries since 1990”. Do no replicate your title, since that will also be read by screenreaders.