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: {
        horserace: [
            [ "HorseraceColumn1Value1", "HorseraceColumn2Value1",
            [ "HorseraceColumn1Value2", "HorseraceColumn2Value2",
            [ "HorseraceColumn1Value3", "HorseraceColumn2Value3",
            ...
        ]
    }
}

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/horserace",
    version: "4",
    bindings: {
        horserace: {
            name: 0, // index of a column in your data
        }
    },
    data: {
        horserace: [
            [ "HorseraceColumn1Value1", "HorseraceColumn2Value1",
            [ "HorseraceColumn1Value2", "HorseraceColumn2Value2",
            [ "HorseraceColumn1Value3", "HorseraceColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@flourish/horserace",
    version: "4",
    bindings: {
        horserace: {
            name: 0, // index of a column in your data
            pic: 1, // index of a column in your data
            stages: [2, 3, ...], // index(es) of column(s) in your data
            filter: 4, // index of a column in your data
        }
    },
    data: {
        horserace: [
            [ "HorseraceColumn1Value1", "HorseraceColumn2Value1",
            [ "HorseraceColumn1Value2", "HorseraceColumn2Value2",
            [ "HorseraceColumn1Value3", "HorseraceColumn2Value3",
            ...
        ]
    }
}

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:

{
        horserace: [
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            ...
        ]
    }

... 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/horserace",
    version: "4",
    bindings: {
        horserace: {
            name: "HorseraceHeader1",
        }
    },
    data: {
        horserace: [
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/horserace",
    version: "4",
    bindings: {
        horserace: {
            name: "HorseraceHeader1",
            pic: "HorseraceHeader2",
            stages: ["HorseraceHeader3", "HorseraceHeader4", ...],
            filter: "HorseraceHeader5",
        }
    },
    data: {
        horserace: [
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            ...
        ]
    }
}

(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/horserace",
    version: "4",
    data: {
    horserace: [
        {
            name: ...,
            stages: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/horserace",
    version: "4",
    data: {
    horserace: [
        {
            name: ...,
            pic: ...,
            stages: [...],
            filter: ...
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

• horserace.name: The name of each entrant
• horserace.pic: The URL of the image to use
• horserace.stages: Raw scores, which will be automatically converted to ranks. Column names will be used to populate the x-axis of the chart.
• horserace.filter: Hide/show entrants based on the values in this column.

Template settings

Options for opts.state.

Scoring type

value_type string

Chart mode to show on load.

higher_scores_win boolean

Data type. Useful for data where lower scores beat higher scores – e.g. race times

ties_mode string

Rank ties mode. What rank ranks should be given when there are ties? See https://en.wikipedia.org/wiki/Ranking for explanation of names.

Interface

show_buttons boolean

Show ranks/scores buttons.

show_replay boolean

Show replay button.

filter_control_type string

Filter control type. Only used when a filter column is specified. "Auto" creates a button group if there is enough space, or a dropdown if there is not.

filter_width number

Control width. Width of control if sufficient space is available.

filter_include_all boolean

Include “All” option.

label_ranks string

“Ranks” label.

label_scores string

“Scores” label.

label_replay string

“Replay” label.

filter_all_label string

“All” label.

Colours

bg_color color

Background colour.

color.palette colors

Palette.

color.extend boolean

Auto-extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once. Added colours are based on the average lightness and chroma values of the palette. This works best if the palette’s colours do not have very high or low saturation.

color.advanced boolean

Fine tune. Fine tune how additional colours are added to the palette.

color.hue_rotation_angle number

Hue rotation for added colours. Angle, in degrees in HCL colourspace, between one generated colour and the next. The default value, ~360/(Golden ratio), ensures adjacent hues are not too similar.

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

Line styles

line_width number

Line width. Width in pixels

line_opacity number

Line opacity. Set to a value between 0 and 1

curve string

Curve.

shade boolean

Show shading behind line.

shade_width number

Shading width. Width in pixels

shade_opacity number

Shading opacity. Set to a value between 0 and 1

missing boolean

Show lines between missing data points.

missing_opacity number

Line opacity.

missing_width number

Line width.

missing_dash_width number

Line dash width.

missing_dash_space number

Line dash space.

Circle styles

start_circle_r number

Start radius.

end_circle_r number

End radius.

end_circle_stroke number

End stroke.

end_circle_stroke_bg boolean

Stroke color same as background.

Label styles

rank_font_size number

Rank font size.

label_font_size number

Label font size.

horse_images boolean

Show image in circle.

rank_outside_picture boolean

Put score next to circle.

hide_labels boolean

Only show label on mouseover.

label_format.prefix string

Prefix. Text to place in front of number

label_format.suffix string

Suffix. Text to place after number

label_format.n_dec number

Decimal places. Use negative integers to round to positive powers of ten (eg -2 rounds to the nearest 100)

label_format.strip_zeros boolean

Remove trailing zeros.

label_format.strip_separator boolean

Hide thousands separator below 10,000. Turn off if you want four-digit numbers to include a separator, e.g. “1,234” rather than “1234”.

label_format.transform_labels boolean

Multiply/divide values.

label_format.transform string

label_format.multiply_divide_constant number

label_format.exponentiate_constant number

Y axis

y_axis_label_colors color

Label colour.

y_axis_label_size number

Font-size.

y_axis_min number

Min score.

y_axis_max number

Max score.

y_axis_min_rank number

Min rank.

y_axis_max_rank number

Max rank.

y_axis_stroke_color color

Stroke colour.

y_axis_format.prefix string

Prefix. Text to place in front of number

y_axis_format.suffix string

Suffix. Text to place after number

y_axis_format.n_dec number

Decimal places. Use negative integers to round to positive powers of ten (eg -2 rounds to the nearest 100)

y_axis_format.strip_zeros boolean

Remove trailing zeros.

y_axis_format.strip_separator boolean

Hide thousands separator below 10,000. Turn off if you want four-digit numbers to include a separator, e.g. “1,234” rather than “1234”.

y_axis_format.transform_labels boolean

Multiply/divide values.

y_axis_format.transform string

y_axis_format.multiply_divide_constant number

y_axis_format.exponentiate_constant number

X axis

x_axis_label_color color

Label colour.

x_axis_label_size number

Font-size.

x_axis_rotate string

Label rotation.

Animation

stage_duration number

Animation duration. The “race” animation length, in milliseconds per stage

update_duration number

Mode duration. The animation duration when change between ranks and scores modes

Margins

margin_top number

Top.

margin_right number

Right.

margin_bottom number

Bottom.

margin_left number

Left.

margin_right_mobile number

Right (mobile).

Header

header.title string

Title.

header.subtitle string

Subtitle.

header.color color

Color.

header.align string

Alignment.

header.margin number

Margin.

header.margin_advanced boolean

Advanced margin settings.

header.margin_top number

Top.

header.margin_right number

Right.

header.margin_bottom number

Bottom.

header.margin_left number

Left.

Footer

footer.source_name string

Source name.

footer.source_url string

Source url.

footer.multiple_sources boolean

Multiple sources.

footer.source_name_2 string

Source name.

footer.source_url_2 string

Source url.

footer.source_name_3 string

Source name.

footer.source_url_3 string

Source url.

footer.source_label string

Source label.

footer.note string

Note.

footer.size number

Size.

footer.color color

Color.

footer.align string

Alignment.

footer.margin number

Overall.

footer.margin_top number

Top.

footer.margin_right number

Right.

footer.margin_bottom number

Bottom.

footer.margin_left number

Left.

footer.margin_advanced boolean

Advanced.

Number formatting

localization.input_decimal_separator string

Decimal separator in data sheet. Used for interpreting your data. Only change if data is not displaying on the chart as expected.

localization.output_separators string

Number format to display. How the numbers should appear on chart labels