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",
            ...
        ],
        captions: [
            [ "CaptionsColumn1Value1", "CaptionsColumn2Value1",
            [ "CaptionsColumn1Value2", "CaptionsColumn2Value2",
            [ "CaptionsColumn1Value3", "CaptionsColumn2Value3",
            ...
        ]
    }
}

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: "17",
    bindings: {
        horserace: {
            name: 0, // index of a column in your data
        },
        captions: {
            
        }
    },
    data: {
        horserace: [
            [ "HorseraceColumn1Value1", "HorseraceColumn2Value1",
            [ "HorseraceColumn1Value2", "HorseraceColumn2Value2",
            [ "HorseraceColumn1Value3", "HorseraceColumn2Value3",
            ...
        ],
        captions: [
            [ "CaptionsColumn1Value1", "CaptionsColumn2Value1",
            [ "CaptionsColumn1Value2", "CaptionsColumn2Value2",
            [ "CaptionsColumn1Value3", "CaptionsColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@flourish/horserace",
    version: "17",
    bindings: {
        horserace: {
            name: 0, // index of a column in your data
            stages: [1, 2, ...], // index(es) of column(s) in your data
            category: 3, // index of a column in your data
            pic: 4, // index of a column in your data
            filter: 5, // index of a column in your data
        },
        captions: {
            from: 0, // index of a column in your data
            to: 1, // index of a column in your data
            text: 2, // index of a column in your data
            image: 3, // index of a column in your data
        }
    },
    data: {
        horserace: [
            [ "HorseraceColumn1Value1", "HorseraceColumn2Value1",
            [ "HorseraceColumn1Value2", "HorseraceColumn2Value2",
            [ "HorseraceColumn1Value3", "HorseraceColumn2Value3",
            ...
        ],
        captions: [
            [ "CaptionsColumn1Value1", "CaptionsColumn2Value1",
            [ "CaptionsColumn1Value2", "CaptionsColumn2Value2",
            [ "CaptionsColumn1Value3", "CaptionsColumn2Value3",
            ...
        ]
    }
}

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": ..., ... },
            ...
        ],
        captions: [
            { "CaptionsHeader1": ..., "CaptionsHeader2": ..., ... },
            { "CaptionsHeader1": ..., "CaptionsHeader2": ..., ... },
            { "CaptionsHeader1": ..., "CaptionsHeader2": ..., ... },
            ...
        ]
    }

... 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: "17",
    bindings: {
        horserace: {
            name: "HorseraceHeader1",
        },
        captions: {
            
        }
    },
    data: {
        horserace: [
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            ...
        ],
        captions: [
            { "CaptionsHeader1": ..., "CaptionsHeader2": ..., ... },
            { "CaptionsHeader1": ..., "CaptionsHeader2": ..., ... },
            { "CaptionsHeader1": ..., "CaptionsHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/horserace",
    version: "17",
    bindings: {
        horserace: {
            name: "HorseraceHeader1",
            stages: ["HorseraceHeader2", "HorseraceHeader3", ...],
            category: "HorseraceHeader4",
            pic: "HorseraceHeader5",
            filter: "HorseraceHeader6",
        },
        captions: {
            from: "CaptionsHeader1",
            to: "CaptionsHeader2",
            text: "CaptionsHeader3",
            image: "CaptionsHeader4",
        }
    },
    data: {
        horserace: [
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            ...
        ],
        captions: [
            { "CaptionsHeader1": ..., "CaptionsHeader2": ..., ... },
            { "CaptionsHeader1": ..., "CaptionsHeader2": ..., ... },
            { "CaptionsHeader1": ..., "CaptionsHeader2": ..., ... },
            ...
        ]
    }
}

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

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

{
    template: "@flourish/horserace",
    version: "17",
    data: {
    horserace: [
        {
            name: ...,
            stages: [...],
            category: ...,
            pic: ...,
            filter: ...
        },
        ...
    ],
    captions: [
        {
            from: ...,
            to: ...,
            text: ...,
            image: ...
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

• horserace.name: The name of each entrant string
• horserace.stages: Raw scores, which will be automatically converted to ranks. Column names will be used to populate the X axis of the chart. number
• horserace.category: Select a column to color the lines by. If omitted, colors will be assigned per name. string
• horserace.pic: Add an image URL or right-click on a cell to upload an image string
• horserace.filter: Hide/show entrants based on the values in this column string, number, datetime
• captions.from: Must match the column headers in the main datasheet string
• captions.to: Must match the column headers in the main datasheet string
• captions.text: Text or <a href="https://help.flourish.studio/article/288-how-to-use-custom-html-and-css">HTML</a> to show string
• captions.image: Image to show string

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/horserace",
    version: "17",
    ...
    data: {
        horserace: [
            [ "HorseraceColumn1Value1", "HorseraceColumn2Value1",
            [ "HorseraceColumn1Value2", "HorseraceColumn2Value2",
            [ "HorseraceColumn1Value3", "HorseraceColumn2Value3",
            ...
        ],
        captions: [
            [ "CaptionsColumn1Value1", "CaptionsColumn2Value1",
            [ "CaptionsColumn1Value2", "CaptionsColumn2Value2",
            [ "CaptionsColumn1Value3", "CaptionsColumn2Value3",
            ...
        ]
    },
    metadata: {
        horserace: {
            0: { type: ..., type_id: ..., output_format_id: ... },
            1: { 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/horserace",
    version: "17",
    data: {
        horserace: [
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            { "HorseraceHeader1": ..., "HorseraceHeader2": ..., ... },
            ...
        ],
        captions: [
            { "CaptionsHeader1": ..., "CaptionsHeader2": ..., ... },
            { "CaptionsHeader1": ..., "CaptionsHeader2": ..., ... },
            { "CaptionsHeader1": ..., "CaptionsHeader2": ..., ... },
            ...
        ]
    },
    metadata: {
        horserace: {
            "HorseraceHeader1": { type: ..., type_id: ..., output_format_id: ... },
            "HorseraceHeader2": { 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.

View

play_mode string

Play mode. In All mode, the entire X axis is visible
In Zoomed mode, the X axis is only visible for a specified amount of stages
In Reveal mode, the X axis is visible from the start until the current stage

zoom_steps_to_show number

Visible stages. The number of time slices (each of which is column of data) to show on the X axis.
When in Zoom mode, these time slices are shown to the left and right of the current time.
In Reveal mode, these time slices are shown at the beginning.

(Value is ignored if the number specified is greater than the number of stages in the data.)

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 ranks should be given when there are ties? See Wikipedia for an explanation of names.

Chart sizing

height_mode string

Height mode. In Fill space mode, the lines will be spread out over the available chart height, which by default will be the standard Flourish chart sizes for any given screen width. In this mode, the circles/images may overlap if you have lots of lines.
Match data mode will resize the embedded graphic so there is enough vertical space to avoid overlaps. (Note this won't have any effect if you embed the graphic as a fixed height.)
Auto mode switches between the two modes depending on the number of lines.

padding_top number

Top. In rems, a multiple of the page's base font size

padding_right number

Right. In rems, a multiple of the page's base font size

padding_bottom number

Bottom. In rems, a multiple of the page's base font size

padding_left number

Left (mobile). In rems, a multiple of the page's base font size

Controls

show_buttons boolean

Ranks/scores toggle.

show_replay boolean

Replay button.

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_background_color color

Background.

filter_control.slider_font_color color

Text.

filter_control.slider_handle_color color

Handle.

filter_control.slider_width number

Width.

filter_control.slider_margin number

Label width.

filter_control.slider_handle_height number

Height.

filter_control.slider_track_height number

Track height.

filter_control.slider_play_button boolean

Play button.

filter_control.slider_loop boolean

Loop.

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_restart_pause number

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

filter_control.sort boolean

Sorting.

filter_include_all boolean

Include “All” option.

label_ranks string

“Ranks”.

label_scores string

“Scores”.

label_replay string

“Replay”.

filter_all_label string

“All”.

controls_style.font_size number

Text size.

controls_style.font_weight string

Text weight.

controls_style.height number

Height.

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.

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.

Colors

color_mode string

Color mode. Whether to color by category (if you have a category column set in the Datasheet), by each individual line, or give every line the same color

color.categorical_palette colors

Palette.

color.categorical_extend boolean

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

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

color.numeric_type string

Scale type.

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

color.bin_mode string

Binning mode.

color.bin_count number

Number of bins.

color.bin_thresholds string

Custom thresholds. Enter your desired thresholds, separating them with a ";". For instance, "5;10;15".

Bins form as follows:

• From the data's minimum value (domain minimum) up to the first threshold.
• Between consecutive thresholds.
• From the last threshold to the data's maximum value (domain maximum).

For "5;10;15", you'll get four bins based on your data's range.


color.sequential_palette string

Palette.


Allowed values:

• Oranges (Oranges)
• Reds (Reds)
• Blues (Blues)
• Greens (Greens)
• Greys (Greys)
• Purples (Purples)
• Viridis (Viridis)
• Inferno (Inferno)
• Magma (Magma)
• Plasma (Plasma)
• Warm (Warm)
• Cool (Cool)
• CubehelixDefault (Cubehelix)
• BuGn (Blue/Green)
• BuPu (Blue/Purple)
• GnBu (Green/Blue)
• OrRd (Orange/Red)
• PuBuGn (Purple/Blue/Green)
• PuBu (Purple/Blue)
• PuRd (Purple/Red)
• RdPu (Red/Purple)
• YlGnBu (Yellow/Blue/Green)
• YlGn (Yellow/Green)
• YlOrBr (Yellow/Orange/Brown)
• YlOrRd (Yellow/Orange/Red)
• Carrots
• Custom

color.sequential_reverse boolean

Reverse.


color.sequential_custom_min color

Minimum color.


color.sequential_custom_max color

Maximum color.


color.sequential_color_space string

Color space.


Allowed values:

• rgb (RGB)
• lab (LAB)
• hcl (HCL)
• hsl (HSL)

color.sequential_custom_domain boolean

Domain.


Allowed values:

• false (Auto)
• true (Custom)

color.sequential_domain_min number

Min.


color.sequential_domain_max number

Max.


color.diverging_palette string

Palette.


Allowed values:

• RdBu (Red/Blue)
• RdYlGn (Red/Yellow/Green)
• PiYG (Pink/Yellow/Green)
• BrBG (Brown/Blue/Green)
• PRGn (Purple/Red/Green)
• PuOr (Purple/Orange)
• RdGy (Red/Grey)
• RdYlBu (Red/Yellow/Blue)
• Spectral (Spectral)
• Custom

color.diverging_reverse boolean

Reverse.


color.diverging_custom_min color

Minimum color.


color.diverging_custom_mid color

Midpoint color.


color.diverging_custom_max color

Maximum color.


color.diverging_color_space string

Color space.


Allowed values:

• rgb (RGB)
• lab (LAB)
• hcl (HCL)
• hsl (HSL)

color.diverging_custom_domain boolean

Domain.


Allowed values:

• false (Auto)
• true (Custom)

color.diverging_domain_min number

Min.


color.diverging_domain_mid number

Mid.


color.diverging_domain_max number

Max.


color_single color

Single color.


color_single_overrides text

Color overrides. Type the label of the line whose color you want to set, a colon and then a color (using a name, hex-code or rgb).

Multiple colors can be set using multiple lines. For example:


---



China: red
India: #4455AA
Brazil: rgb(30,168,26)


Line styles

line_width number

Line width.


line_opacity number

Opacity.


Max: 1

curve string

Curve.


Allowed values:

• curveLinear (Straight)
• curveMonotoneX (Normal curve)
• curveNatural (Overflowing curve)
• curveStep (Step middle)
• curveStepAfter (Step after)
• curveStepBefore (Step before)

shade boolean

Shading behind line.


Allowed values:

• true (On)
• false (Off)

shade_width number

Width. Width in pixels


shade_opacity number

Opacity. Set to a value between 0 and 1


Max: 1

missing boolean

Lines between missing data points.


Allowed values:

• true (On)
• false (Off)

missing_opacity number

Opacity.


Max: 1

missing_width number

Width.


missing_stroke_dash number

Stroke dash.


Circle styles

start_circle_r number

Start radius. In rems, a multiple of the page's base font size


end_circle_r number

End radius. In rems, a multiple of the page's base font size


end_circle_stroke number

End stroke.


circle_space_between number

Space between. Minimum space between the circles. The space is ignored when the chart is set to fill available space.


end_circle_stroke_bg boolean

Stroke color.


Allowed values:

• true (Background)
• false (Line)

horse_images boolean

Image inside circle.


Allowed values:

• true (On)
• false (Off)

Label styles

show_labels string

Show labels.


Allowed values:

• always (Always)
• hover (On hover)
• never (Never)

animate_scores boolean

Animate scores.


rank_outside_picture boolean

Value label position.


Allowed values:

• false (Inside)
• true (Outside)

label_divider string

Divider. The character between label and value


rank_inside_color color

Color.


labels.max_width number

Max label width. The maximum allowed label width


labels.overlap_mode string

Overlaps. What to do with overlaps


Allowed values:

• spread (Spread them out)
• hide (Hide them)
• none (Do nothing)

labels.spreading_margin number

Space between labels. The space left between labels when spreading them out to avoid overlaps


labels.data_point_margin number

Distance. The space between the data point and the label in rems (a multiple of base font size)


labels.show_only_labels text

Show only certain labels. Manually specify which labels you'd like to display (one entry per line that should match entries in the Label column)


labels.text_color color

Color.


labels.text_size number

Size.


Max: 100

labels.text_bg_color color

Outline.


labels.text_bg_size number

Outline width. As a % of the font size


Max: 100

labels.text_line_height number

Line height.


labels.text_max_lines number

Max lines. The max number of lines for each label


labels.text_weight string

Weight.


Predefined values:

• 400 (Normal)
• 700 (Bold)

labels.lines string

Connector lines.


Allowed values:

• auto (Auto)
• on (On)
• off (Off)

labels.line_style string

Line style.


Allowed values:

• straight (Straight)
• step (Step)

labels.line_color color

Color.


labels.line_width number

Width. In rems (a multiple of base font size)


Max: 0.5

labels.line_range number

Length. The width of the space given over to lines; in rems, a multiple of base font size


labels.line_padding number

Padding. The padding to the left and right of the line; in rems, a multiple of base font size


X axis

x.axis_position string

Position.


Allowed values:

• bottom (Bottom)
• float-below (Float ↓)
• float-above (Float ↑)
• top (Top)
• off (Hidden)

x.y_axis_position string

Y value. Vertical position of the X axis on the Y scale


x.numeric_scale_type string

Type.


Allowed values:

• linear (Linear)
• log (Log)

x.linear_min number

Min.


x.linear_max number

Max.


x.log_min number

Min.


x.log_max number

Max.


x.datetime_min string

Min (date).


x.datetime_max string

Max (date).


x.flip boolean

Flip axis.


x.show_scale_settings boolean

Configure default min/max.


x.nice boolean

Round min/max. Enabling this option rounds the X axis start and end values to <a href="https://help.flourish.studio/article/224-how-to-avoid-gaps-between-axes-and-series>tidy numbers, such as 0, 50, 100 or whole years. Specified min and max values will override this feature.


Allowed values:

• true (On)
• false (Off)

x.zero_axis string

Include zero. Enable to extend the axis to include zero, even when data is all positive or all negative. This is ignored if you set specific min and max scale values.


Allowed values:

• auto (Auto)
• on (On)
• off (Off)

x.title_mode string

Type.


Allowed values:

• auto (Auto)
• custom (Custom)

x.title string

Text.


x.title_styling boolean

Styling.


x.title_weight string

Weight.


Allowed values:

• bold (Bold)
• normal (Regular)

x.title_color color

Color.


x.title_size number

Size.


x.title_padding number

Padding.


x.tick_label_position string

Position.


Allowed values:

• default (Default)
• left (Left)
• right (Right)

x.tick_label_styling boolean

Styling.


x.tick_label_size number

Size.


x.tick_label_color color

Color.


x.tick_padding number

Padding.


x.tick_label_angle string

Angle.


Allowed values:

• 0 (0°)
• 30 (30°)
• 45 (45°)
• 60 (60°)
• 90 (90°)

x.tick_label_weight string

Weight.


Allowed values:

• bold (Bold)
• normal (Regular)

x.tick_label_max_lines number

Max lines.


Min: 1

x.tick_label_line_height number

Line height.


x.tick_label_space_mode string

Space mode.


Allowed values:

• auto (Auto)
• max (Max)
• fixed (Fixed)

x.tick_label_space number

Space.


x.tick_mode string

Mode. Sets the method for selecting tick values on the axis:

Auto automatically selects the ticks
Number allows you to choose the number of ticks to display.
Custom lets you select specific ticks to show.

Note: If the axis is categorical, Number mode is ignored.


Allowed values:

• auto (Auto)
• number (Number)
• custom (Custom)

x.tick_number number

Number. Approximate number of ticks or gridlines. The actual number will depend on the range of values, chart size, etc.


x.tick_custom text

One tick label per line. Specify the ticks to show, one per line. For dates, use the input format as specified in the datasheet.

You can also use {{FIRST}} and {{LAST}} to add ticks at the minimum and maximum of the axis. For example:

{{FIRST}}
25000
50000
75000
{{LAST}}


x.line_and_tick_color color

Line color.


x.line_and_tick_width number

Line width.


x.tick_length number

Tick length.


x.tick_side string

Tick side.


Allowed values:

• out (Out)
• in (In)

x.line_visible boolean

Axis line.


x.edge_padding number

Edge padding (%). Space between start/end of axis line and first/last category tick as a percentage of the spacing between ticks


Max: 100

x.gridlines_visible boolean

Allowed values:

• true (On)
• false (Off)

x.gridlines_styling boolean

Styling.


x.gridline_color color

Color.


x.gridline_style string

Style.


Allowed values:

• solid (Solid)
• dash (Dashed)
• dot (Dotted)
• dot_dash (Dot-dashed)

x.gridline_width number

Width.


x.gridline_category_dividers boolean

Put lines between categories. On a categorical axis, this option disables the gridline on each tick and instead adds rules between each category to give a table-like design.


x.gridline_category_dividers_extend boolean

Extend. Extends the dividers into the axis margins.


Y axis

y.axis_visible boolean

Allowed values:

• true (Axis visible)
• false (Axis hidden)

y.numeric_scale_type string

Type.


Allowed values:

• linear (Linear)
• log (Log)

y.linear_min number

Min.


y.linear_max number

Max.


y.log_min number

Min.


y.log_max number

Max.


y.datetime_min string

Min (date).


y.datetime_max string

Max (date).


y.flip boolean

Flip axis.


y.show_scale_settings boolean

Configure default min/max.


y.nice boolean

Round min/max. When enabled, scales automatically extend to "nice" rounded start/end values, such as hundreds or whole years.


Allowed values:

• true (On)
• false (Off)

y.zero_axis string

Include zero. Whether to extend the axis to include zero if the data values are all positive or all negative.


Allowed values:

• auto (Auto)
• on (On)
• off (Off)

y.title_mode string

Type.


Allowed values:

• auto (Auto)
• custom (Custom)

y.title string

Text.


y.title_styling boolean

Styling.


y.title_position string

Position.


Allowed values:

• side (Side)
• end (Top/bottom)

y.title_weight string

Weight.


Allowed values:

• bold (Bold)
• normal (Regular)

y.title_color color

Color.


y.title_size number

Size.


y.title_padding number

Padding.


y.tick_label_position string

Position.


Allowed values:

• default (Default)
• above (Above)
• below (Below)

y.tick_label_styling boolean

Styling.


y.tick_label_size number

Size.


y.tick_label_color color

Color.


y.tick_padding number

Padding.


y.tick_label_angle string

Angle.


Allowed values:

• 0 (0°)
• 30 (30°)
• 45 (45°)
• 60 (60°)
• 90 (90°)

y.tick_label_weight string

Weight.


Allowed values:

• bold (Bold)
• normal (Regular)

y.tick_label_max_lines number

Max lines.


Min: 1

y.tick_label_line_height number

Line height.


y.tick_label_space_mode string

Space mode.


Allowed values:

• auto (Auto)
• max (Max)
• fixed (Fixed)

y.tick_label_space number

Space.


y.tick_mode string

Mode. Sets the method for selecting tick values on the axis:

Auto automatically selects the ticks
Number allows you to choose the number of ticks to display.
Custom lets you select specific ticks to show.

Note: If the axis is categorical, Number mode is ignored.


Allowed values:

• auto (Auto)
• number (Number)
• custom (Custom)

y.tick_number number

Number. Approximate number of ticks or gridlines. The actual number will depend on the range of values, chart size, etc.


y.tick_custom text

One tick label per line. Specify the ticks to show, one per line. For dates, use the input format as specified in the datasheet.

You can also use {{FIRST}} and {{LAST}} to add ticks at the minimum and maximum of the axis. For example:

{{FIRST}}
25000
50000
75000
{{LAST}}


y.line_and_tick_color color

Line color.


y.line_and_tick_width number

Line width.


y.tick_length number

Tick length.


y.tick_side string

Side.


Allowed values:

• out (Out)
• in (In)

y.line_visible boolean

Axis line.


y.edge_padding number

Edge padding (%). Space between start/end of axis line and first/last category tick as a percentage of the spacing between ticks


Max: 100

y.gridlines_visible boolean

Allowed values:

• true (On)
• false (Off)

y.gridlines_styling boolean

Styling.


y.gridline_color color

Color.


y.gridline_style string

Style.


Allowed values:

• solid (Solid)
• dash (Dashed)
• dot (Dotted)
• dot_dash (Dot-dashed)

y.gridline_width number

Width.


y.gridline_category_dividers boolean

Put lines between categories. On a categorical axis, this option disables the gridline on each tick and instead adds rules between each category to give a table-like design. Ignored for date and numeric axes.


y.gridline_category_dividers_extend boolean

Extend. Extends the dividers into the axis margins


zoom_y_axis boolean

Dynamic Y axis. Rescales the y axis when filtering or playing in zoomed mode


Captions

caption_background_color color

Background.


caption_border_color color

Border.


caption_border_radius number

Radius.


caption_opacity number

Opacity.


Max: 1

caption_padding number

Padding. In rems, a multiple of the page's base font size


caption_position string

Position.


Allowed values:

• top-left (Top left)
• center-left (Center left)
• bottom-left (Bottom left)
• top-right (Top right)
• center-right (Center right)
• bottom-right (Bottom right)
• top-center (Top center)
• center-center (Center)
• bottom-center (Bottom center)

caption_text_width number

Width.


caption_font_size number

Font size. In rems, a multiple of the page's base font size


caption_text_weight string

Weight.


Allowed values:

• normal (Normal)
• bold (Bold)

caption_text_color color

Color.


caption_mode string

Content mode. In Text with colors mode, any phrases matching category names will be automatically colored.

In HTML mode, no colors will be applied, but you can include any HTML in the datasheet to add images, etc.


Allowed values:

• text_legend (Text with colors)
• html (HTML)

caption_text_align_h string

Horizontal align.


Allowed values:

• start (fa-align-left)
• center (fa-align-center)
• end (fa-align-right)

caption_text_align_v string

Vertical align.


Allowed values:

• flex-start (Top)
• center (Center)
• flex-end (Bottom)

caption_image_width number

Width.


Max: 100

caption_image_position string

Position.


Allowed values:

• column (Images below (content above))
• column-reverse (Images above (content below))
• row (Images right (content left))
• row-reverse (Images left (content right))

caption_space_between number

Space between. Space between image and text


Animation

stage_duration number

Animation duration. The race animation length, in milliseconds per stage(A stage is equal to each column of your data).


update_duration number

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


Number formatting

formatting.prefix string

Prefix. Text to place in front of a number


formatting.suffix string

Suffix. Text to place after a number


formatting.n_dec number

Decimal places. Decimal places. You can also enter a negative integer to round to a whole number with that many zeros. For example, -2 will round to the nearest hundred.


Min: -10

Max: 10

formatting.advanced boolean

Advanced.


formatting.negative_sign string

Styling of negative numbers.


Allowed values:

• -$nk (-$100k)
• $-nk ($-100k)
• ($nk) (($100k))
• $(n)k ($(100)k)
• none ($100k)

formatting.strip_zeros boolean

Remove trailing zeros.


formatting.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”.


formatting.transform_labels boolean

Multiply/divide values.


formatting.transform string

Allowed values:

• multiply (Multiply by)
• divide (Divide by)
• exponentiate (×10 to the power of)

formatting.multiply_divide_constant number

formatting.exponentiate_constant number

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:

• true (On)
• false (Off)

layout.background_image_enabled boolean

Image.


Allowed values:

• true (On)
• false (Off)

layout.background_color color

Background color.


layout.background_image_src url

Image URL.


layout.background_image_size string

Size.


Allowed values:

• cover (Fill)
• contain (Fit)
• auto (Original)
• 100% 100% (Stretch)

layout.background_image_position string

Position.


Allowed values:

• top left (Top left)
• top center (Top center)
• top right (Top right)
• center left (Center left)
• center center (Center)
• center right (Center right)
• bottom left (Bottom left)
• bottom center (Bottom center)
• bottom right (Bottom right)

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:

• none (None)
• wrapper (Everything)
• primary (Main graphic)

layout.max_width number

Maximum width. Leave blank to stretch to container width


Min: 50

layout.max_width_align string

Align.


Allowed values:

• left (fa-align-left)
• center (fa-align-center)
• right (fa-align-right)

layout.layout_order string

Layout order.


Allowed values:

• stack-default (Header – controls – legend – primary graphic – footer)
• stack-2 (Primary graphic – header – controls – legend – footer)
• stack-3 (Header – primary graphic – controls – legend – footer)
• stack-4 (Controls – primary graphic – header – legend – footer)
• stack-5 (Header – controls – primary graphic – legend – footer)
• grid-1 (Grid mode: Primary graphic on the right)

layout.space_between_sections string

Space between sections.


Allowed values:

• 0.5 (▁)
• 1 (▃)
• 1.5 (▄)
• custom (...)

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:

• solid (Solid)
• dashed (Dashed)
• dotted (Dotted)

layout.border.top.color color

Color.


layout.border.right.width number

Right.


layout.border.right.style string

Style.


Allowed values:

• solid (Solid)
• dashed (Dashed)
• dotted (Dotted)

layout.border.right.color color

Color.


layout.border.bottom.width number

Bottom.


layout.border.bottom.style string

Style.


Allowed values:

• solid (Solid)
• dashed (Dashed)
• dotted (Dotted)

layout.border.bottom.color color

Color.


layout.border.left.width number

Left.


layout.border.left.style string

Style.


Allowed values:

• solid (Solid)
• dashed (Dashed)
• dotted (Dotted)

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.

Note that when direction is set to right to left any alignment icons will be reversed.


Allowed values:

• ltr (Left to right)
• rtl (Right to left)

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:

• left (fa-align-left)
• center (fa-align-center)
• right (fa-align-right)

layout.title html

layout.title_styling boolean

Styling.


layout.title_font font

Title Font.


layout.title_size string

Size.


Allowed values:

• 1.4 (ᴀ)
• 1.6 (A)
• 2 (fa-font)
• custom (...)

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:

• bold (Bold)
• normal (Regular)

layout.title_color color

Color.


layout.title_line_height number

Line height.


Max: 3

layout.title_space_above string

Space above.


Allowed values:

• 0 (▁)
• 0.5 (▃)
• 1 (▄)
• custom (...)

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:

• 1.4 (ᴀ)
• 1.6 (A)
• 2 (fa-font)
• custom (...)

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:

• bold (Bold)
• normal (Regular)

layout.subtitle_color color

Color.


layout.subtitle_line_height number

Line height.


Max: 3

layout.subtitle_space_above string

Space above.


Allowed values:

• 0 (▁)
• 0.5 (▃)
• 1 (▄)
• custom (...)

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:

• 1.2 (ᴀ)
• 1.4 (A)
• 1.6 (fa-font)
• custom (...)

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:

• bold (Bold)
• normal (Regular)

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:

• 0 (▁)
• 0.5 (▃)
• 1 (▄)
• custom (...)

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:

• solid (Solid)
• dashed (Dashed)
• dotted (Dotted)

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:

• inside (Header)
• outside (Main container)

layout.header_logo_position_inside string

Position.


Allowed values:

• top (Top)
• left (Left)
• right (Right)

layout.header_logo_position_outside string

Position.


Allowed values:

• left (Left)
• right (Right)

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:

• left (fa-align-left)
• center (fa-align-center)
• right (fa-align-right)
• justify (fa-align-justify)

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:

• bold (Bold)
• normal (Regular)

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. To add the time/date stamp of when the data was last updated add {{data_last_updated}}. For example, "Last updated at {{data_last_updated}}". To customize the format, use the advanced options below.


layout.footer_note_secondary html

Note (secondary). The secondary note is placed below the source and primary note. To add the time/date stamp of when the data was last updated add {{data_last_updated}}. For example, "Last updated at {{data_last_updated}}". To customize the format, use the advanced options below.


layout.advanced_note_styling boolean

Advanced.


layout.footer_timestamp_format string

Time/date stamp formatting. To change the date/time format of your timestamp, choose from the below options or provide a custom date format in d3-time-format syntax


Predefined values:

• %H:%M:%S (13:39:13)
• %I:%M %p (01:39 PM)
• %H:%M (13:39)
• %H:%M %p (13:39 PM)
• %H:%M:%S, %d %b %Y (13:39:13, 28 Jan 2024)
• %H:%M, %d %b %Y (13:39, 28 Jan 2024)
• %H:%M, %d/%m/%Y (13:39, 28/01/2024)
• %H:%M, %m/%d/%Y (13:39, 01/28/2024)
• %H:%M, %d-%m-%Y (13:39, 28-01-2024)
• %H:%M, %m-%d-%Y (13:39, 01-28-2024)
• %d %b %Y (28 Jan 2024)
• %m/%d/%Y (01/28/2024)
• %d/%m/%Y (28/01/2024)
• %m-%d-%Y (01-28-2024)
• %d-%m-%Y (28-01-2024)
• %Y-%m-%d (2024-01-28)
• %Y-%m-%d %H:%M:%S (2024-01-28 13:39:13)

layout.footer_logo_enabled boolean

Image.


Allowed values:

• true (Enabled)
• false (Disabled)

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:

• left (Left)
• right (Right)

layout.footer_align_vertical string

V. align.


Allowed values:

• flex-start (Top)
• center (Center)
• flex-end (Bottom)

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:

• solid (Solid)
• dashed (Dashed)
• dotted (Dotted)

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:

• true (Hidden)
• false (Readable)