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/radar",
    version: "1",
    bindings: {
        data: {
            name: 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/radar",
    version: "1",
    bindings: {
        data: {
            name: 0, // index of a column in your data
            values: [1, 2, ...], // index(es) of column(s) in your data
            filter: 3, // index of a column in your data
            color_category: 4, // index of a column in your data
            facet: [5, 6, ...], // index(es) of column(s) 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/radar",
    version: "1",
    bindings: {
        data: {
            name: "DataHeader1",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/radar",
    version: "1",
    bindings: {
        data: {
            name: "DataHeader1",
            values: ["DataHeader2", "DataHeader3", ...],
            filter: "DataHeader4",
            color_category: "DataHeader5",
            facet: ["DataHeader6", "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/radar",
    version: "1",
    data: {
    data: [
        {
            name: ...,
            values: [...],
            facet: [...],
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/radar",
    version: "1",
    data: {
    data: [
        {
            name: ...,
            values: [...],
            filter: ...,
            color_category: ...,
            facet: [...],
            metadata: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

• data.name: A text column containing a name for each radar
• data.values: Select three or more numerical columns
• data.filter: If set, creates a filter menu or time slider
• data.color_category: Add a category to color by. If empty, the "name" column will be used for colors.
• data.facet: Create one column for each grouping you want to allow
• data.metadata: Add any columns here containing extra content to show in the popups

Template settings

Options for opts.state.

Shapes

radars.curve string

Line curve.

radars.star boolean

Line shape.

radars.stroke_width number

Line width.

radars.stroke_opacity number

Line opacity.

radars.fill_opacity number

Fill opacity.

radars.star_inner_radius number

Star inner. The star shape's inner radius, as a percent of the max radius

color.scale_type string

Scale type.

color.categorical_palette colors

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

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.

facet_comparisons boolean

Show comparison lines in grid mode.

facet_comparison_stroke color

Line.

facet_comparison_stroke_width number

Line width.

facet_comparison_stroke_opacity number

Line opacity.

facet_comparison_fill color

Fill.

facet_comparison_fill_opacity number

Fill opacity.

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.titles boolean

Show titles.

facets.title_align string

Alignment.

facets.title_size number

Size. Relative to the width of the chart

facets.title_color color

Colour.

facets.title_padding_top number

Space above.

facets.title_padding_bottom number

Space below.

facets.title_bg string

Background.

facets.title_bg_color color

Colour.

facets.title_bg_padding number

Space left and right.

facets.animation string

Animation. In "reuse" mode, a facet with one title can be "reused" for data with another title (e.g. when filtering an axis could be reused for new data). In "By name", the facet will be locked to its name; if the name is no longer in the data the facet will be removed and a fresh one will enter, with any animation that entails. Auto decides for you based on the data.

Radial axis

Radial axis

radial_axis.axis_show boolean

radial_axis.x_line_color color

Line.

radial_axis.x_line_width number

Width.

radial_axis.x_tick_label_color color

Color.

radial_axis.x_tick_label_size number

Size.

radial_axis.x_tick_label_outline number

Outline.

radial_axis.x_tick_label_weight string

radial_axis.y_min number

Min value.

radial_axis.y_max number

Max value.

radial_axis.y_tick_number number

Number.

radial_axis.y_line_color color

Color.

radial_axis.y_line_width string

Width.

radial_axis.y_line_dash string

Dash.

radial_axis.y_line_dash_gap string

Gap.

radial_axis.y_tick_label_color color

Color.

radial_axis.y_tick_label_size number

Size.

radial_axis.y_tick_label_outline number

Outline.

radial_axis.y_tick_label_space number

Space.

radial_axis.y_tick_label_weight string

radial_axis.margin_top number

Top.

radial_axis.margin_right number

Right.

radial_axis.margin_bottom number

Bottom.

radial_axis.margin_left number

Left.

radial_axis.group_labels text

Outer labels. Enter one per line, with an angle and a label separated by a colon, such as:

50: My Label

radial_axis.group_labels_color color

Color.

radial_axis.group_labels_size number

Size.

radial_axis.group_labels_letter_spacing number

Letter spacing.

radial_axis.group_labels_space_above number

Space above.

radial_axis.group_labels_space_below number

Space below.

Legend

legend.show_legend boolean

legend.text_color color

Color.

legend.text_size number

Size.

legend.text_weight string

Weight.

legend.title_mode string

Title mode.

legend.title string

Title.

legend.title_weight string

Weight.

legend.swatch_width number

Width.

legend.swatch_height number

Height.

legend.swatch_radius number

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

legend.order_override text

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

legend.orientation string

Orientation.

Controls

facet_control_show boolean

Show charts grid control.

facet_control_default string

Option to show on load. If you want to specify a different facet view to show on load either make a story or enter the label from the relevant button here. Case sensitive.

facet_control_none boolean

Include combined option.

facets_label_combined string

Combined label.

facet_control_individual boolean

Include separate option.

facets_label_separate string

Separate label.

facets_control.control_type string

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

facets_control.control_styles boolean

Adv..

facets_control.control_title string

Control title.

facets_control.button_group boolean

Grouped.

facets_control.button_group_width_mode string

Button group width.

facets_control.button_group_width_fixed number

Width.

facets_control.dropdown_width_mode string

Dropdown width.

facets_control.dropdown_width_fixed number

Width.

facets_control.slider_background_color color

Background.

facets_control.slider_font_color color

Text.

facets_control.slider_handle_color color

Handle.

facets_control.slider_width number

Width.

facets_control.slider_margin number

Label width.

facets_control.slider_handle_height number

Height.

facets_control.slider_track_height number

Track height.

facets_control.slider_play_button boolean

Play button.

facets_control.slider_loop boolean

Loop.

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

facets_control.slider_restart_pause number

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

facets_control.sort string

Sorting.

facets_control.sort_temporal_format string

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

filter_control.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 string

Sorting.

filter_control.sort_temporal_format string

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

filter_control_all string

Name for "All". Leave blank to not include an "All" option

filter_y_max boolean

Update axis y max when filtering.

style_controls.font_size number

Text size.

style_controls.font_weight string

Text weight.

style_controls.padding number

Height. Space below and above controls text

style_button.background color

Background.

style_button.background_selected color

Selected.

style_button.background_hover color

Mouse over.

style_button.font_color color

Text color.

style_button.font_color_selected color

Selected.

style_button.font_color_hover color

Mouse over.

style_button.button_styles_advanced boolean

Button border styles.

style_button.border_width number

Border width.

style_button.border_color color

Color.

style_button.border_transparency number

Transparency.

style_button.border_radius number

Radius.

style_dropdown.background color

Background.

style_dropdown.font_color color

Text color.

style_dropdown.border_styles_advanced boolean

Dropdown border styles.

style_dropdown.border_style string

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

style_dropdown.border_width number

Border width.

style_dropdown.border_color color

Color.

style_dropdown.border_transparency number

Transparency.

style_dropdown.border_radius number

Radius.

Popups & panels

popup.mode string

popup.popup_is_custom boolean

Popup content.

popup.show_popup_styles boolean

Show popup styles.

popup.popup_custom_header string

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 text

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 string

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 text

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_color_headings boolean

Color popup headings.

Animation

duration number

Duration. In seconds

Number styles

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.body_font font

Main font. This font will apply to the whole graphic by default, but you can optionally change the font for the title, subtitle, footer, etc in the Header and Footer settings panels.

layout.font_color color

Text color. This color will apply to the whole graphic by default, but you can optionally change the color for individual text elements, in other settings panels.

layout.background_color_enabled boolean

Color.

layout.background_image_enabled boolean

Image.

layout.background_color color

Background color.

layout.background_image_src url

Image URL.

layout.background_image_size string

Size.

layout.background_image_position string

Position.

layout.max_width_target string

Maximum width. Apply a maximum width to just the main graphic or everything (main graphic plus header, footer, etc)

layout.max_width number

Maximum width. Leave blank to stretch to container width

layout.max_width_align string

Align.

layout.layout_order string

Layout order.

layout.space_between_sections string

Space between sections.

layout.space_between_sections_custom number

Custom.

layout.margin_top number

Top.

layout.margin_right number

Right.

layout.margin_bottom number

Bottom.

layout.margin_left number

Left.

layout.border.enabled boolean

Show borders around visualisation.

layout.border.top.width number

Top.

layout.border.top.style string

Style.

layout.border.top.color color

Color.

layout.border.right.width number

Right.

layout.border.right.style string

Style.

layout.border.right.color color

Color.

layout.border.bottom.width number

Bottom.

layout.border.bottom.style string

Style.

layout.border.bottom.color color

Color.

layout.border.left.width number

Left.

layout.border.left.style string

Style.

layout.border.left.color color

Color.

Header

layout.header_align string

Alignment.

layout.title string

layout.title_styling boolean

Change title styles.

layout.title_font font

Title Font.

layout.title_size string

Size.

layout.title_size_custom number

Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3

layout.title_weight string

Weight.

layout.title_color color

Color.

layout.title_line_height number

Line height.

layout.title_space_above string

Space above.

layout.title_space_above_custom number

Custom.

layout.subtitle string

layout.subtitle_styling boolean

Change subtitle styles.

layout.subtitle_font font

Subtitle Font.

layout.subtitle_size string

Size.

layout.subtitle_size_custom number

Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3

layout.subtitle_weight string

Weight.

layout.subtitle_color color

Color.

layout.subtitle_line_height number

Line height.

layout.subtitle_space_above string

Space above.

layout.subtitle_space_above_custom number

Custom.

layout.header_text string

layout.header_text_styling boolean

Styling.

layout.header_text_size string

Size.

layout.header_text_size_custom number

Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3

layout.header_text_weight string

Weight.

layout.header_text_color color

Color.

layout.header_text_line_height number

Line height.

layout.header_text_space_above string

Space above.

layout.header_text_space_above_custom number

Custom.

layout.header_border string

layout.header_border_width number

Width.

layout.header_border_color color

Color.

layout.header_border_style string

Style.

layout.header_border_space number

Space. Space between border and header text

layout.header_logo_enabled boolean

layout.header_logo_src url

URL.

layout.header_logo_height number

Height.

layout.header_logo_align string

Align. Align logo inside header or outer visualisation container

layout.header_logo_position_inside string

Position.

layout.header_logo_position_outside string

Position.

layout.header_logo_margin_top number

Top.

layout.header_logo_margin_right number

Right.

layout.header_logo_margin_bottom number

Bottom.

layout.header_logo_margin_left number

Left.

Footer

layout.footer_align string

Alignment.

layout.footer_text_size number

Size.

layout.footer_text_color color

Color.

layout.footer_styling boolean

Advanced footer styles.

layout.footer_font font

Font.

layout.source_name string

Source name.

layout.source_url string

Source url.

layout.multiple_sources boolean

Multiple sources.

layout.source_name_2 string

Source name.

layout.source_url_2 string

Source url.

layout.source_name_3 string

Source name.

layout.source_url_3 string

Source url.

layout.source_label string

Source label.

layout.footer_note string

Note.

layout.footer_note_secondary string

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

layout.footer_logo_enabled boolean

Image.

layout.footer_logo_src url

Image.

layout.footer_logo_src_light hidden

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

layout.footer_logo_link_url string

Link.

layout.footer_logo_height number

Height.

layout.footer_logo_margin number

Margin.

layout.footer_logo_order string

Position.

layout.footer_align_vertical string

V. align.

layout.footer_border string

layout.footer_border_width number

Width.

layout.footer_border_color color

Color.

layout.footer_border_style string

Style.

layout.footer_border_space number

Space. Space between border and footer text

Accessibility

layout.screenreader_hide_primary boolean

Screenreader mode for main visual container. Whether the main visual container is visible to screenreaders. (Text in the header and footer are always available to screenreaders.)

layout.screenreader_text_primary text

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