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

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

{
    template: "@flourish/scatter",
    version: "12",
    bindings: {
        data: {
            x: 0, // index of a column in your data
            y: 1, // index of a column in your data
            name: [2, 3, ...], // index(es) of column(s) in your data
            color: 4, // index of a column in your data
            size: 5, // index of a column in your data
            shape: 6, // index of a column in your data
            facet: 7, // index of a column in your data
            slider: 8, // index of a column in your data
            series: 9, // index of a column in your data
            filter: 10, // index of a column in your data
            metadata: [11, 12, ...], // 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/scatter",
    version: "12",
    bindings: {
        data: {
            
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/scatter",
    version: "12",
    bindings: {
        data: {
            x: "DataHeader1",
            y: "DataHeader2",
            name: ["DataHeader3", "DataHeader4", ...],
            color: "DataHeader5",
            size: "DataHeader6",
            shape: "DataHeader7",
            facet: "DataHeader8",
            slider: "DataHeader9",
            series: "DataHeader10",
            filter: "DataHeader11",
            metadata: ["DataHeader12", "DataHeader13", ...],
        }
    },
    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/scatter",
    version: "12",
    data: {
    data: [
        {
            name: [...],
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/scatter",
    version: "12",
    data: {
    data: [
        {
            x: ...,
            y: ...,
            name: [...],
            color: ...,
            size: ...,
            shape: ...,
            facet: ...,
            slider: ...,
            series: ...,
            filter: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

• data.x: x
• data.y: y
• data.name: Select multiple columns if required to make a unique name.
• data.color: Colours the dots based on numbers or categories
• data.size: Sizes the dots based on numbers or categories
• data.shape: Sets the shape of the dots based on numbers or categories
• data.facet: Creates a mini chart for each value in the selected column
• data.slider: Creates a time slider and connects/animates dots with the same name
• data.series: Group dots into series based on the contents of a column
• data.filter: Creates a control based on the contents of any column
• data.metadata: Makes additional columns (text, emoji, image URLs, etc) available in custom popups

Template settings

Options for opts.state.

Dot styles

default_color color

Default colour. Used when Colour column is unspecified

fill_opacity number

Dot opacity.

default_shape string

Default shape. Used when Shape column is unspecified or empty

data_point_default_size number

Size. In pixel area. Only used when Size column is unspecified or empty. Subject to scaling with the chart size (see seeing below).

data_point_min_size number

Min size. In pixel area. Used when you have a Size column selected. Subject to scaling with the chart size.

data_point_max_size number

Max size. In pixel area. Used when you have a Size column selected. Subject to scaling with the chart size.

responsive_dots boolean

Scale dots based on chart size. Makes the dots get bigger or smaller relative to the chart size. Turn off to specify a fixed sizes regardless of chart size.

stroke_opacity number

Outline opacity.

stroke_width number

Outline width.

stroke_mode string

Outline mode. Choose Auto for Outline colour to match Dot colour. Choose Fixed to give all dots a uniform Outline colour.

stroke_color color

Outline colour.

render_mode string

Renderer. In most cases you should only need SVG, but you may want to choose WebGL if you have a lot of data or you notice your chart is running slowly on your device.

Dot colours

color_type string

Data type.

color.scale_type string

Scale type.

color.categorical_palette colors

Palette when shading by categorical column.

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.

spectrum string

Palette when shading by a number column. Ignored unless the selected “Colour” column is numerical. These schemes are drawn from D3 and ColorBrewer.

Dot labels

labels_show boolean

Show labels on points. Labels only show up if you have designated a “Name” column in the data tab

labels_selective boolean

Labels to show. To show labels selectively, turn on this option and then make a story. In the story editor click on dots to hide/show the labels.

label_color_type string

Label colour.

label_color color

Fixed.

labels_responsive string

Scale label. Choose between no scale, scale by chart size, or try to fit the label in the data point.

label_font_size number

Font size.

label_font_size_min number

Min font size.

label_font_size_max number

Max font size.

label_bg_size number

Shadow size. As percent of font size

label_align string

Alignment. Align the text at start, middle or end of the data point.

Chart set-up

height_mode string

Sizing mode. In “Fill space” mode the graphic will fill the container (which by default will be the the standard Flourish responsive chart size). In “Aspect ratio” mode you set the aspect ratio of the plot and the container will be updated to acommodate it (not supported when embedded in a simple fixed-height iframe).

facet_aspect number

Chart height (as % of chart width). Height as percent of width. Ignored if embedded at fixed height.

chart_bg.background_color_enabled boolean

Color.

chart_bg.background_image_enabled boolean

Image.

chart_bg.background_color color

Color.

chart_bg.background_image_src url

Image URL.

chart_bg.background_image_size string

Size.

chart_bg.background_image_position string

Position.

margin_top number

Top.

margin_right number

Right.

margin_bottom number

Bottom.

margin_left number

Left.

Grid of charts

facet_fixed_cols boolean

Fixed number of columns in grid.

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

facet_cols number

Number of columns in grid.

facet_gutter_w number

Horizontal. In rems

facet_gutter_h number

Vertical. In rems

facet_header_font_size number

Text size. In rems

facet_title_align string

Alignment.

facet_header_color color

Colour.

Lines & arrows

lines_show boolean

Shows lines.

line_width_responsive boolean

Line width.

line_width_min number

Min size.

line_width_max number

Max size.

line_width number

Line width.

line_curve string

Line style.

line_opacity number

Line opacity.

line_color_mode string

Line color. When set to “Match dots” the lines will be the same as the first dot in the line

line_color color

Colour.

line_arrows boolean

Arrow heads on lines.

line_arrow_size number

Size.

line_arrow_color_mode string

Colour mode.

line_arrow_color color

Colour.

X axis

x_type string

Data type.

x_matching boolean

Matching x axis across grid of charts.

x_single_row boolean

Only show x axis on first column of grid.

x.axis_position string

Position.

x.y_axis_position string

Y value. Vertical position of the x axis on the y scale

x.numeric_scale_type string

Type.

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

Configure default min/max.

x.nice boolean

Round min/max. When enabled, scales automatically extend to "nice" rounded start/end values, such as hundreds or whole years. Overridden by any explicitly specified scale min and max.

x.zero_axis string

Include zero. Whether to extend the axis to include zero if the data values are all positive or all negative. Overridden by any explicitly specified scale min and max.

x.title_mode string

Type.

x.title string

Text.

x.title_styling boolean

Styling.

x.title_weight string

Weight.

x.title_color color

Color.

x.title_size number

Size.

x.title_padding number

Padding.

x.tick_label_position string

Position.

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.

x.tick_label_weight string

Weight.

x.tick_label_max_lines number

Max lines.

x.tick_label_line_height number

Line height.

x.tick_label_space_mode string

Space mode.

x.tick_label_space number

Space.

x.tick_mode string

Mode.

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

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.

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

x.gridlines_visible boolean

x.gridlines_styling boolean

Styling.

x.gridline_color color

Color.

x.gridline_style string

Style.

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. Ignored for date and numeric axes.

x.gridline_category_dividers_extend boolean

Extend. Extends the dividers into the axis margins.

x_formatting.prefix string

Prefix. Text to place in front of number

x_formatting.suffix string

Suffix. Text to place after number

x_formatting.n_dec number

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

x_formatting.advanced boolean

Advanced.

x_formatting.negative_sign string

Styling of negative numbers.

x_formatting.strip_zeros boolean

Remove trailing zeros.

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

x_formatting.transform_labels boolean

Multiply/divide values.

x_formatting.transform string

x_formatting.multiply_divide_constant number

x_formatting.exponentiate_constant number

Y axis

y_type string

Data type.

y_matching boolean

Matching y axis across grid of charts.

y_single_col boolean

Only show Y axis on first column of grid.

y.axis_visible boolean

y.numeric_scale_type string

Type.

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.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. Ignored for cagorical scales, and overridden by any specified min/max.

y.zero_axis string

Include zero. Whether to extend the axis to include zero if the data values are all positive or all negative. Ignored for date and categorical scales, and overridden by any specified min/max.

y.title_mode string

Type.

y.title string

Text.

y.title_styling boolean

Styling.

y.title_weight string

Weight.

y.title_color color

Color.

y.title_size number

Size.

y.title_padding number

Padding.

y.tick_label_position string

Position.

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.

y.tick_label_weight string

Weight.

y.tick_label_max_lines number

Max lines.

y.tick_label_line_height number

Line height.

y.tick_label_space_mode string

Space mode.

y.tick_label_space number

Space.

y.tick_mode string

Mode.

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

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.

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

y.gridlines_visible boolean

y.gridlines_styling boolean

Styling.

y.gridline_color color

Color.

y.gridline_style string

Style.

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

y_formatting.prefix string

Prefix. Text to place in front of number

y_formatting.suffix string

Suffix. Text to place after number

y_formatting.n_dec number

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

y_formatting.advanced boolean

Advanced.

y_formatting.negative_sign string

Styling of negative numbers.

y_formatting.strip_zeros boolean

Remove trailing zeros.

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

y_formatting.transform_labels boolean

Multiply/divide values.

y_formatting.transform string

y_formatting.multiply_divide_constant number

y_formatting.exponentiate_constant number

Legend

legend_position string

Legend position.

legend_filtering_mode string

Clickable legend. When a legend item is clicked on, the corresponding dots can either be hidden or shown. This option can also be turned off.

categorical_legend.show_legend boolean

categorical_legend.text_color color

Color.

categorical_legend.text_size number

Size.

categorical_legend.text_weight string

Weight.

categorical_legend.title_mode string

Title mode.

categorical_legend.title string

Title.

categorical_legend.title_weight string

Weight.

categorical_legend.swatch_width number

Width.

categorical_legend.swatch_height number

Height.

categorical_legend.swatch_radius number

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

categorical_legend.order_override text

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

categorical_legend.orientation string

Orientation.

continuous_legend.show_legend boolean

continuous_legend.text_color color

Color.

continuous_legend.text_size number

Size.

continuous_legend.text_weight string

Weight.

continuous_legend.title_mode string

Title mode.

continuous_legend.title string

Title.

continuous_legend.title_weight string

Weight.

continuous_legend.color_band_width number

Width.

continuous_legend.color_band_height number

Height.

continuous_legend.color_band_radius number

Roundness. The radius of the corners of the color band (in pixels)

continuous_legend.binned_label_mode string

Binned label mode.

continuous_legend.binned_label_custom string

Custom bin labels. List numeric values, separated by semi-colons.

continuous_legend.legend_min number

Legend min.

continuous_legend.legend_max number

Legend max.

text_legend string

text_legend_title boolean

Title.

text_legend_subtitle boolean

Subtitle.

text_legend_bold boolean

Bold. If checked, always use bold for coloured items

color_formatting.prefix string

Prefix. Text to place in front of number

color_formatting.suffix string

Suffix. Text to place after number

color_formatting.n_dec number

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

color_formatting.advanced boolean

Advanced.

color_formatting.negative_sign string

Styling of negative numbers.

color_formatting.strip_zeros boolean

Remove trailing zeros.

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

color_formatting.transform_labels boolean

Multiply/divide values.

color_formatting.transform string

color_formatting.multiply_divide_constant number

color_formatting.exponentiate_constant number

Popups

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

Color popup headings.

popup_sticky boolean

Make popups sticky on click. Note that when in webGL mode, the sticky popups won't be preserved in the story player

popup_parse_numbers boolean

Interpret and style number columns.

Filter

filter.control_type string

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

filter.control_styles boolean

Adv..

filter.button_group boolean

Grouped.

filter.button_group_width_mode string

Button group width.

filter.button_group_width_fixed number

Width.

filter.dropdown_width_mode string

Dropdown width.

filter.dropdown_width_fixed number

Width.

filter.slider_background_color color

Background.

filter.slider_font_color color

Text.

filter.slider_handle_color color

Handle.

filter.slider_width number

Width.

filter.slider_margin number

Label width.

filter.slider_handle_height number

Height.

filter.slider_track_height number

Track height.

filter.slider_play_button boolean

Play button.

filter.slider_loop boolean

Loop.

filter.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.slider_restart_pause number

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

filter.sort string

Sorting.

filter.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_show_all boolean

Include "All".

filter_show_all_text string

“All” label.

filter_updates_axes boolean

Update axes when filtering.

Time slider

slider_updates_axes boolean

Update axes when using slider.

time_label_show boolean

Show time label.

time_label_color color

Colour.

time_label_opacity number

Opacity.

time_label_font_size number

Size. As a percent of the default size; the actual size scales with the chart

Controls style

controls_style.font_size number

Text size.

controls_style.font_weight string

Text weight.

controls_style.padding number

Height. Space below and above controls text

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

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

slider.control_styles boolean

Adv..

slider.button_group boolean

Grouped.

slider.button_group_width_mode string

Button group width.

slider.button_group_width_fixed number

Width.

slider.dropdown_width_mode string

Dropdown width.

slider.dropdown_width_fixed number

Width.

slider.slider_background_color color

Background.

slider.slider_font_color color

Text.

slider.slider_handle_color color

Handle.

slider.slider_width number

Width.

slider.slider_margin number

Label width.

slider.slider_handle_height number

Height.

slider.slider_track_height number

Track height.

slider.slider_play_button boolean

Play button.

slider.slider_loop boolean

Loop.

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

slider.slider_restart_pause number

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

slider.sort string

Sorting.

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

Trend lines

fit_type string

Lines to show.

fit_force_origin boolean

Force line through origin.

fit_line_width number

Width.

fit_line_dash number

Dash.

fit_line_color color

Colour.

Box, violin and beeswarm plots

beeswarm_plot boolean

Show beeswarm when plotting one numerical and one categorical axis. Auto mode will make a beeswarm unless there are more than 5000 points in the dataset. Performance will be reduced with thousands of rows due to the nature of how beeswarm positions are computed.

box_plot boolean

Show box plot when plotting one numerical and one categorical axis.

box_color color

Box colour.

box_opacity number

Box opacity.

box_line_color color

Line colour.

box_line_width number

Line width.

box_whisker_type string

Whisker type.

box_whisker_multiplier number

Max whisker length (number of IQR's). Maximum distance whiskers should extend out from the box as a multiple of the interquartile range. 1.5 is John Tukey's classsic value

violin_plot boolean

Show violin plot when plotting one numerical and one categorical axis.

violin_bandwidth number

Bandwidth. Leave blank to use a bandwidth based on the data

violin_samples number

No. of samples. Number of points at which to calculate a violin's distribution. More points means a more accurate curve but can also harm performance.

violin_color color

Colour.

violin_opacity number

Opacity.

violin_sizing string

Sizing mode.

Annotations

anno_x_enabled boolean

Show highlights on the x axis.

anno_x_lines text

One per line, in format “Thing :: 28000”. You can optionally also specify a color using the format “My label :: 28000 :: #44CCCC”. For visualizations containing a grid of mini charts, you can also apply the annotation on only a specific chart using the format, e.g. “My label :: 28000 :: #44CCCC :: Chart name”.

anno_x_line_color color

Colour.

anno_x_line_width number

Width.

anno_x_line_dash number

Dash.

anno_x_areas text

One per line, in format “Thing :: 20000 >> 24000”. You can optionally also specify a color using the format “My label :: 20000 >> 24000 :: #44CCCC”. For visualizations containing a grid of mini charts, you can also apply the annotation on only a specific chart using the format, e.g. “My label :: 2000 >> 24000 :: #44CCCC :: Chart name”.

anno_x_fill_color color

Area.

anno_x_label_color color

Text.

anno_x_fill_opacity number

Area opacity.

anno_x_label_align string

Labels.

anno_x_label_font_size number

Font size. In rems

anno_y_enabled boolean

Show highlights on the y axis.

anno_y_lines text

One per line, in format “Thing :: 6”. You can optionally also specify a color using the format “My label :: 6 :: #44CCCC”. For visualizations containing a grid of mini charts, you can also apply the annotation on only a specific chart using the format, e.g. “My label :: 6 :: #44CCCC :: Chart name”.

anno_y_line_color color

Colour.

anno_y_line_width number

Width.

anno_y_line_dash number

Dash.

anno_y_areas text

One per line, in format “Thing :: 7 >> 9”. You can optionally also specify a color using the format “My label :: 7 >> 9 :: #44CCCC”. For visualizations containing a grid of mini charts, you can also apply the annotation on only a specific chart using the format, e.g. “My label :: 7 >> 9 :: #44CCCC :: Chart name”.

anno_y_fill_color color

Area.

anno_y_label_color color

Text.

anno_y_fill_opacity number

Area opacity.

anno_y_label_align string

Align.

anno_y_label_font_size number

Font size. In rems

annotations_styling boolean

Show annotations styling.

annotations.defaults.text_weight string

Weight.

annotations.defaults.text_size number

Text size.

annotations.defaults.label_width number

Max text width.

annotations.defaults.line_marker string

Line marker.

annotations.defaults.connector_extend_line string

Extend line.

annotations.defaults.stroke_width number

Stroke width.

annotations.defaults.popup_position string

Popup position.

annotations.defaults.text_color color

Text.

annotations.defaults.text_bg color

Text Outline.

annotations.defaults.point_text_color color

Label.

annotations.defaults.popup_bg color

Popup.

annotations.defaults.stroke_color color

Stroke.

annotations.defaults.subject_fill color

Fill.

annotations.defaults.subject_fill_opacity number

Fill opacity.

Animations

animation_duration number

Animation duration. The duration of the animation for each dot or axis, in seconds

animation_stagger number

Animation stagger. The delay between each dot starting to move, in seconds; set to 0 to have all dots move simultaneously

line_animate_on_load boolean

Animate lines on load. Whether to “animate in” lines when the graphic first loads

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

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.