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: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

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/slope-chart",
    version: "11",
    bindings: {
        data: {
            id: 0, // index of a column in your data
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@flourish/slope-chart",
    version: "11",
    bindings: {
        data: {
            id: 0, // index of a column in your data
            values: [1, 2, ...], // index(es) of column(s) in your data
            line_thickness: 3, // index of a column in your data
            filter: 4, // index of a column in your data
            color_category: 5, // index of a column in your data
            facet: 6, // index of a column in your data
            metadata: [7, 8, ...], // index(es) of column(s) in your data
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

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:

{
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }

... 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/slope-chart",
    version: "11",
    bindings: {
        data: {
            id: "DataHeader1",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/slope-chart",
    version: "11",
    bindings: {
        data: {
            id: "DataHeader1",
            values: ["DataHeader2", "DataHeader3", ...],
            line_thickness: "DataHeader4",
            filter: "DataHeader5",
            color_category: "DataHeader6",
            facet: "DataHeader7",
            metadata: ["DataHeader8", "DataHeader9", ...],
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

(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/slope-chart",
    version: "11",
    data: {
    data: [
        {
            id: ...,
            values: [...],
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/slope-chart",
    version: "11",
    data: {
    data: [
        {
            id: ...,
            values: [...],
            line_thickness: ...,
            filter: ...,
            color_category: ...,
            facet: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

• data.id: The name of the data series (eg. voting district, data mode)
• data.values: Values for that data series (eg. % of votes).
• data.line_thickness: Values for the thickness of line
• data.filter: filter
• data.color_category: color_category
• data.facet: facet
• data.metadata: Makes additional columns (text, emoji, image URLs, etc) avaiable in custom popups

Template settings

Options for opts.state.

Slopes

circle_radius number

Circle radius.

slope_width number

Slope width.

slope_width_max number

Max slope width.

slope_color color

Slope color. If not set, will use same color as main text

curve string

Line curve.

color.categorical_palette colors

Palette for categories.

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

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

color.sequential_palette string

Palette.

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.

color.sequential_custom_domain boolean

Domain.

color.sequential_domain_min number

Min.

color.sequential_domain_max number

Max.

color.diverging_palette string

Palette.

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.

color.diverging_custom_domain boolean

Domain.

color.diverging_domain_min number

Min.

color.diverging_domain_mid number

Mid.

color.diverging_domain_max number

Max.

selected_slopes text

Highlight slopes. To highlight slopes, write the name of each slope on a line. You can also create a a story and highlight/unhighlight by clicking. Leave empty to highlight all slopes.

Chart mode

value_type string

Value mode.

ties_mode string

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

sort_mode string

Sort mode.

height_mode string

Height mode.

aspect_ratio number

Aspect ratio. 1 for square, a smaller value means a bigger height.

Grid of charts

facets.columns_fixed boolean

Number of columns. In Auto mode, the number of columns will change with screen size

facets.min_width number

Min chart width. Determines how many columns of charts there should be in the grid. Ignored if you specify a fixed number of columns.

facets.max_width number

Max chart width. Determines how many columns of charts there should be in the grid. Ignored if you specify a fixed number of columns.

facets.columns number

Fixed number of columns.

facets.gutter_w number

Horizontal margin.

facets.gutter_h number

Vertical margin.

facets.animation string

On data change. If a chart in the grid is removed, that cell can either be animated out (with another cell moving to take its place) or reused for the new data in that cell. Auto decides for you based on the data.

facets.titles boolean

Show titles.

facets.title_align string

Alignment.

facets.title_size number

Size. Relative to the width of the chart

facets.title_unit string

Scale with chart.

facets.title_color color

Color.

facets.title_padding_top number

Space above.

facets.title_padding_bottom number

Space below.

facets.title_bg string

Background.

facets.title_bg_color color

Color.

facets.title_bg_padding number

Padding. Horizontal space between text and background

axis_first_row_only boolean

Show X axis on first row only.

matching_y_axis boolean

Matching Y scale across facets.

Labels

labels_name_position string

Slope name mode.

labels_position string

Slope name position. "Both" mode will fallback to "Start" on narrow windows and devices

labels_inline_position string

Slope name position.

labels_inline_position_custom text

Custom slope name positions. Change the position of each individual label. One line per label.

Syntax
Label name :: start/middle/end :: offset in % (optional)

Example
Luxembourg :: end :: 10
France :: start

only_show_highlights boolean

Only show highlighted labels.

line_labels.max_width number

Max label width. The maximum allowed label width

line_labels.overlap_mode string

Overlaps. What to do with overlaps

line_labels.spreading_margin number

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

line_labels.data_point_margin number

Distance. The space between the data point and the label

line_labels.text_color color

Color.

line_labels.text_size number

Size.

line_labels.text_bg_color color

Outline.

line_labels.text_bg_size number

Outline width. As a % of the font size

line_labels.text_line_height number

Line height.

line_labels.text_max_lines number

Max lines. The max number of lines for each label

line_labels.text_weight string

Weight. The vertical space left between labels when positioning them

line_labels.lines string

Connector lines.

line_labels.line_style string

Line style.

line_labels.line_color color

Color.

line_labels.line_width number

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

line_labels.line_range number

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

line_labels.line_padding number

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

Popup

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

popup.max_width number

Max width.

Axis

axis_labels_position string

Position.

axis_font_size number

Font size.

axis_text_color color

Font color.

axis_color color

Axis color.

axis_width number

Axis width.

axis_dashoffset string

Axis dash. eg. 2,2

Controls

update_y_axis_filter boolean

Update Y axis when filtering.

controls.control_type string

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

controls.control_styles boolean

Adv..

controls.control_title string

Control title.

controls.button_group boolean

Grouped.

controls.button_group_width_mode string

Button group width.

controls.button_group_width_fixed number

Width.

controls.dropdown_width_mode string

Dropdown width.

controls.dropdown_width_fixed number

Width.

controls.slider_width number

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

controls.slider_max_label_width number

Max label width. In rems, multiples of base font size. If larger than the longest label, only the space required to fit labels will be used.

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

controls.slider_loop boolean

Loop.

controls.slider_restart_pause number

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

controls.sort boolean

Sorting.

filter_show_all boolean

Include "All".

filter_show_all_text string

“All” label.

controls_style.font_size number

Text size.

controls_style.font_weight string

Text weight.

controls_style.height number

Height.

dropdown_style.background color

Background.

dropdown_style.font_color color

Text color.

dropdown_style.border_styles_advanced boolean

Dropdown border styles.

dropdown_style.border_style string

Border style. Show border on all sides, or only at the bottom

dropdown_style.border_width number

Border width.

dropdown_style.border_color color

Color.

dropdown_style.border_transparency number

Transparency.

dropdown_style.border_radius number

Radius.

button_style.background color

Background.

button_style.background_selected color

Selected.

button_style.background_hover color

Mouse over.

button_style.font_color color

Text color.

button_style.font_color_selected color

Selected.

button_style.font_color_hover color

Mouse over.

button_style.button_styles_advanced boolean

Button border styles.

button_style.border_width number

Border width.

button_style.border_color color

Color.

button_style.border_transparency number

Transparency.

button_style.border_radius number

Radius.

slider_style.track_color color

Track.

slider_style.font_color color

Text.

slider_style.handle_color color

Handle.

slider_style.play_color color

Play/pause.

slider_style.track_height number

Track height.

slider_style.handle_height number

Height.

slider_style.play_button boolean

Play button.

Animations

animation_duration number

Animation duration. The duration of the animation (in milliseconds) when changing data or mode – for example between slides in a story

Legend

legend_categorical.show_legend boolean

legend_categorical.title_mode string

Title mode.

legend_categorical.title string

Title.

legend_categorical.swatch_width number

Width.

legend_categorical.swatch_height number

Height.

legend_categorical.swatch_radius number

Roundness. The radius of the corners of the swatch (in pixels)

legend_categorical.legend_items_padding number

Padding. Padding between legend items (in rems)

legend_categorical.order_override text

Custom order override. Manually specify the order of legend entries (one entry per line)

legend_categorical.icon_height number

Height. Height of icon (relative to the base font size)

legend_categorical.icon_color color

Color. Fallback color (icon color if not determined by template)

legend_categorical.max_width number

Max width.

legend_categorical.orientation string

Orientation.

legend_position string

Position.

legend_container.alignment string

Alignment.

legend_container.orientation string

Orientation.

legend_container.title_weight string

Title weight.

legend_container.text_weight string

Text weight.

legend_container.text_color color

Color.

legend_container.text_size number

Size.

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

formatting.prefix string

Prefix. Text to place in front of number

formatting.suffix string

Suffix. Text to place after number

formatting.n_dec number

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

formatting.advanced boolean

Advanced.

formatting.negative_sign string

Styling of negative numbers.

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

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

URL settings

url_state.enabled boolean

Update project from URL. Make it possible to change the visualization's settings/state from the URL hash, for example when embedding in an iframe or popup panel

url_state.whitelist text

Allowed state properties. List each state property you want to make changeable with the URL hash. See the template page for a full list of state properties. Add one property name per line. Use dot format for nested properties, e.g. layout.background_color