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: {
        matches: [
            [ "MatchesColumn1Value1", "MatchesColumn2Value1",
            [ "MatchesColumn1Value2", "MatchesColumn2Value2",
            [ "MatchesColumn1Value3", "MatchesColumn2Value3",
            ...
        ],
        teams: [
            [ "TeamsColumn1Value1", "TeamsColumn2Value1",
            [ "TeamsColumn1Value2", "TeamsColumn2Value2",
            [ "TeamsColumn1Value3", "TeamsColumn2Value3",
            ...
        ]
    }
}

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/tournament",
    version: "1",
    bindings: {
        matches: {
            round: 0, // index of a column in your data
            team_a: 1, // index of a column in your data
            team_b: 2, // index of a column in your data
        },
        teams: {
            
        }
    },
    data: {
        matches: [
            [ "MatchesColumn1Value1", "MatchesColumn2Value1",
            [ "MatchesColumn1Value2", "MatchesColumn2Value2",
            [ "MatchesColumn1Value3", "MatchesColumn2Value3",
            ...
        ],
        teams: [
            [ "TeamsColumn1Value1", "TeamsColumn2Value1",
            [ "TeamsColumn1Value2", "TeamsColumn2Value2",
            [ "TeamsColumn1Value3", "TeamsColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@flourish/tournament",
    version: "1",
    bindings: {
        matches: {
            round: 0, // index of a column in your data
            team_a: 1, // index of a column in your data
            team_b: 2, // index of a column in your data
            winner: 3, // index of a column in your data
            score_a: 4, // index of a column in your data
            score_b: 5, // index of a column in your data
            metadata: [6, 7, ...], // index(es) of column(s) in your data
        },
        teams: {
            id: 0, // index of a column in your data
            image: 1, // index of a column in your data
        }
    },
    data: {
        matches: [
            [ "MatchesColumn1Value1", "MatchesColumn2Value1",
            [ "MatchesColumn1Value2", "MatchesColumn2Value2",
            [ "MatchesColumn1Value3", "MatchesColumn2Value3",
            ...
        ],
        teams: [
            [ "TeamsColumn1Value1", "TeamsColumn2Value1",
            [ "TeamsColumn1Value2", "TeamsColumn2Value2",
            [ "TeamsColumn1Value3", "TeamsColumn2Value3",
            ...
        ]
    }
}

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:

{
        matches: [
            { "MatchesHeader1": ..., "MatchesHeader2": ..., ... },
            { "MatchesHeader1": ..., "MatchesHeader2": ..., ... },
            { "MatchesHeader1": ..., "MatchesHeader2": ..., ... },
            ...
        ],
        teams: [
            { "TeamsHeader1": ..., "TeamsHeader2": ..., ... },
            { "TeamsHeader1": ..., "TeamsHeader2": ..., ... },
            { "TeamsHeader1": ..., "TeamsHeader2": ..., ... },
            ...
        ]
    }

... 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/tournament",
    version: "1",
    bindings: {
        matches: {
            round: "MatchesHeader1",
            team_a: "MatchesHeader2",
            team_b: "MatchesHeader3",
        },
        teams: {
            
        }
    },
    data: {
        matches: [
            { "MatchesHeader1": ..., "MatchesHeader2": ..., ... },
            { "MatchesHeader1": ..., "MatchesHeader2": ..., ... },
            { "MatchesHeader1": ..., "MatchesHeader2": ..., ... },
            ...
        ],
        teams: [
            { "TeamsHeader1": ..., "TeamsHeader2": ..., ... },
            { "TeamsHeader1": ..., "TeamsHeader2": ..., ... },
            { "TeamsHeader1": ..., "TeamsHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/tournament",
    version: "1",
    bindings: {
        matches: {
            round: "MatchesHeader1",
            team_a: "MatchesHeader2",
            team_b: "MatchesHeader3",
            winner: "MatchesHeader4",
            score_a: "MatchesHeader5",
            score_b: "MatchesHeader6",
            metadata: ["MatchesHeader7", "MatchesHeader8", ...],
        },
        teams: {
            id: "TeamsHeader1",
            image: "TeamsHeader2",
        }
    },
    data: {
        matches: [
            { "MatchesHeader1": ..., "MatchesHeader2": ..., ... },
            { "MatchesHeader1": ..., "MatchesHeader2": ..., ... },
            { "MatchesHeader1": ..., "MatchesHeader2": ..., ... },
            ...
        ],
        teams: [
            { "TeamsHeader1": ..., "TeamsHeader2": ..., ... },
            { "TeamsHeader1": ..., "TeamsHeader2": ..., ... },
            { "TeamsHeader1": ..., "TeamsHeader2": ..., ... },
            ...
        ]
    }
}

(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/tournament",
    version: "1",
    data: {
    matches: [
        {
            round: ...,
            team_a: ...,
            team_b: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/tournament",
    version: "1",
    data: {
    matches: [
        {
            round: ...,
            team_a: ...,
            team_b: ...,
            winner: ...,
            score_a: ...,
            score_b: ...,
            metadata: [...]
        },
        ...
    ],
    teams: [
        {
            id: ...,
            image: ...
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

• matches.round: The stage of the tournament, for example "Round of 16" or "Semifinals"
• matches.team_a: The first participant or team in this match
• matches.team_b: The second participant or team in this match
• matches.winner: The winning participant or team in this match. Must match the name of either Participant A or Participant B. If left blank, the template will assume that the match is upcoming.
• matches.score_a: The score of Participant A in this match. Will appear along with the participant's name in the box. string, number
• matches.score_b: The score of Participant B in this match. Will appear along with the participant's name in the box. string, number
• matches.metadata: One or more columns of information to be included in popups and panels string, number, datetime
• teams.id: Participant ID. Should match a participant's name from the Matches sheet.
• teams.image: Image URL of an image to render in the participant box.

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/tournament",
    version: "1",
    ...
    data: {
        matches: [
            [ "MatchesColumn1Value1", "MatchesColumn2Value1",
            [ "MatchesColumn1Value2", "MatchesColumn2Value2",
            [ "MatchesColumn1Value3", "MatchesColumn2Value3",
            ...
        ],
        teams: [
            [ "TeamsColumn1Value1", "TeamsColumn2Value1",
            [ "TeamsColumn1Value2", "TeamsColumn2Value2",
            [ "TeamsColumn1Value3", "TeamsColumn2Value3",
            ...
        ]
    },
    metadata: {
        matches: {
            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/tournament",
    version: "1",
    data: {
        matches: [
            { "MatchesHeader1": ..., "MatchesHeader2": ..., ... },
            { "MatchesHeader1": ..., "MatchesHeader2": ..., ... },
            { "MatchesHeader1": ..., "MatchesHeader2": ..., ... },
            ...
        ],
        teams: [
            { "TeamsHeader1": ..., "TeamsHeader2": ..., ... },
            { "TeamsHeader1": ..., "TeamsHeader2": ..., ... },
            { "TeamsHeader1": ..., "TeamsHeader2": ..., ... },
            ...
        ]
    },
    metadata: {
        matches: {
            "MatchesHeader1": { type: ..., type_id: ..., output_format_id: ... },
            "MatchesHeader2": { type: ..., type_id: ..., output_format_id: ... },
            "MatchesHeader3": { 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 Recognised Type Formats.

Template settings

Options for opts.state.

Chart sizing

min_round_width_mode string

Width mode. "Auto" mode sets round width to the smallest it can be while still fitting text content. In "Fixed" mode you can choose a fixed minimum round width (text will be ellipsed if it does not fit).

min_round_width_fixed number

Min stage width. The minimum width given to a specific stage (e.g. Quarterfinals), specified in px

inner_padding_vertical number

Box height.

inner_padding_horizontal number

Box padding. Horizontal space on sides of box

link_width number

Horizontal space. Horizontal space between stages.

outer_padding number

Vertical space. Vertical space between stages.

Chart styling

winning_team_color color

Winning team.

losing_team_color color

Losing team.

upcoming_fill_color color

Upcoming match.

boxes_stroke_color color

Outline color.

boxes_stroke_width number

Outline width.

boxes_roundness number

Roundness.

winning_team_text_color color

Winning team.

losing_team_text_color color

Losing team.

font_size number

Size. Sizing unit is relative to root font size (rems)

text_weight_mode string

Weight.

link_thickness number

Thickness. Specified in rems

link_color color

Color.

link_radius number

Roundness. Specified in rems

Images

image_size number

Size. Specified as a % of the box for that match

image_scale string

Scale. "Stretch" will not preserve the aspect ratio of images but stretch them to fill the area. "Fit" and "Zoom" both preserve the aspect ratio of images, but "Fit" ensures none of the image is cut off while "Zoom" allows you to zoom the image to better fill the circular or square clip path.

image_zoom number

Zoom. Sets what size the image should fill the container as a percentage of the container size

image_shape string

Shape.

Stage headings

headings_enabled boolean

headings_size number

Size. Sizing unit is relative to root font size

headings_padding number

Padding. Sizing unit is relative to root font size

headings_color color

Color.

headings_weight string

Weight.

headings_position string

Position.

Mobile navigation

navigation_icon_position string

Position.

navigation_icon_mode string

Type.

navigation_icon_upload url

Upload icon. Upload a right-facing icon (your icon will be rotated for the left side)

navigation_icon_size number

Size. Sizing unit is relative to root font size

navigation_icon_color color

Color.

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

popup_header_separator string

Header separator.

Animation

animation_duration number

Duration. The duration, in seconds, of intro animation

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.

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