Scatter

Powerful scatter plot with optional time slider, mini charts, and tracker lines

Updated 2 years ago by Template retirement home

How to use this template

Scatter

A template for creating two-dimensional scatter plots, ideal for showing correlation, trends and outliers. Extra information can be encoded using colour, shape and size, and data can be divided (or “faceted”) into multiple smaller datasets using the “Grid of charts” feature.

Data requirements

To make a simple scatter chart, all you need is two columns of data: one for the x (horizontal) axis and one for the y (vertical) axis. Each row is plotted as a “dot”, and the spread of dots on the chart shows the relationship between the two metrics. Addition columns can be used to set the colour, size and shape of the dots, or to create interactive controls and custom popups.

Showing change over time

If your data has a column with years or dates, you can create an animated scatter showing change over time, as popularised by Hans Rosling’s famous TED talks. Select a “Time” column to create a slider and choose one or more “Name” columns so the template knows which rows represent the same thing. Rows with the same name will be animated through time and also joined together with lines (which can styled or turned off in the settings panel).

Tips

  • Overwhelmed by the number of points? Choose a “Filter” column to create a menu to switch between subsets of the data.
  • Want to compare subsets alongside each other? Select a “Grid of charts” column to create an array of mini charts.
  • Want to show a custom popup? You can include as many “Info” columns as you like, and advanced users can even use HTML and CSS to pull in pictures from a column of image URLs.
  • Try making a Flourish story to guide an audience through different views of your scatter visualisation.

This section documents API usage specific to this template, so for an introduction we suggest you refer to the generic API documentation instead.

template: _595

version: _40

Template data

There are two different formats in which you can supply data to this template. Which one will be more convenient for you likely depends on the source of your data, as described below.

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. To tell the API how these 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: "_595",
    version: "_40",
    bindings: {
        data: {
            x: "DataHeader1",
            y: "DataHeader2"
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "_595",
    version: "_40",
    bindings: {
        data: {
            x: "DataHeader1",
            y: "DataHeader2",
            name: ["DataHeader3", "DataHeader4", ...],
            color: "DataHeader5",
            size: "DataHeader6",
            shape: "DataHeader7",
            facet: "DataHeader8",
            slider: "DataHeader9",
            filter: "DataHeader10",
            metadata: ["DataHeader11", "DataHeader12", ...]
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

(As before, the keys containing "Header" would be replaced by column names from your data source.)

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: "_595",
version: "_40",
data: {
    data: [
        {
            x: ...,
            y: ...,
            name: [...],
            metadata: [...]
        },
        ...
    ]
},
...
}

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

{
template: "_595",
version: "_40",
data: {
    data: [
        {
            x: ...,
            y: ...,
            name: [...],
            color: ...,
            size: ...,
            shape: ...,
            facet: ...,
            slider: ...,
            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.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.

header.title string

Title.

header.subtitle string

Subtitle.

header.color color

Color.

header.align string

Alignment.

Allowed values:

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

header.margin number

Margin.

header.margin_advanced boolean

Advanced margin settings.

header.margin_top number

Top.

header.margin_right number

Right.

header.margin_bottom number

Bottom.

header.margin_left number

Left.

Page design

bg_color color

Background colour.

Legend text colour. Also affects the slider label, if present

facet_title_color color

Chart name. Only used in grid mode

slider_buttons_color color

Slider. Only used when you have a “Time slider” column selected

legend_show boolean

Show legend.

Dots

default_color color

Default colour. Used when Colour column is unspecified or empty

data_point_default_size number

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

Min: 1

default_shape string

Default shape. Used when Shape column is unspecified or empty

Allowed values:

  • symbolCircle (Circle)
  • symbolCross (Cross)
  • symbolDiamond (Diamond)
  • symbolSquare (Square)
  • symbolStar (Star)
  • symbolTriangle (Triangle)
  • symbolWye (Wye)

palette string

When colouring by a category column. "Choose from the list or enter a custom palette as a comma-separated list of colour codes or names (e.g. #343434, red). Ignored unless selected “Colour” column contains words."

Predefined values:

  • flourish_default_1 (Flourish categories A)
  • flourish_default_2 (Flourish categories B)
  • carto_pastel (Pastel light)
  • carto_antique (Pastel dark)
  • carto_rainbow (Rainbow)
  • schemeCategory20 (20 colours (paired))

spectrum string

When colouring by a number column. Ignored unless selected “Colour” column contains numbers. These schemes are drawn from D3 and ColorBrewer.

Allowed values:

  • interpolateBlues (Blues (linear))
  • interpolateGreens (Greens (linear))
  • interpolateGreys (Greys (linear))
  • interpolatePurples (Purples (linear))
  • interpolateReds (Reds (linear))
  • interpolateBuGn (Blue-Green (linear))
  • interpolateBuPu (Blue-Purple (linear))
  • interpolateGnBu (Green-Blue (linear))
  • interpolateOrRd (Orange-Red (linear))
  • interpolatePuBuGn (Purple-Blue-Green (linear))
  • interpolatePuBu (Purple-Blue (linear))
  • interpolatePuRd (Purple-Red (linear))
  • interpolateRdPu (Red-Purple (linear))
  • interpolateYlGnBu (Yellow-Green-Blue (linear))
  • interpolateYlGn (Yellow-Green (linear))
  • interpolateYlOrBr (Yellow-Orange-Brown (linear))
  • interpolateYlOrRd (Yellow-Orange-Red (linear))
  • interpolateInferno (Inferno (spectrum))
  • interpolateMagma (Magma (spectrum))
  • interpolatePlasma (Plasma (spectrum))
  • interpolateWarm (Warm (spectrum))
  • interpolateCool (Cool (spectrum))
  • interpolateViridis (Viridis (spectrum))
  • interpolateOranges (Oranges (spectrum))
  • interpolateBrBG (Brown-BlueGreen (diverging))
  • interpolatePRGn (PurpleRed-Green (diverging))
  • interpolatePiYG (Pink-YellowGreen (diverging))
  • interpolatePuOr (Purple-Orange (diverging))
  • interpolateRdBu (Red-Blue (diverging))
  • interpolateRdGy (Red-Grey (diverging))
  • interpolateRdYlBu (Red-Yellow-Blue (diverging))
  • interpolateRdYlGn (Red-Yellow-Gn (diverging))
  • interpolateSpectral (Spectral (diverging))

fill_opacity number

Dot opacity.

Max: 1

stroke_opacity number

Outline opacity.

Max: 1

stroke_width number

Outline width.

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.

Min: 1

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.

Min: 1

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.

Layout

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

Allowed values:

  • auto (Auto)
  • fill_space (Fill space)
  • aspect (Aspect ratio)

facet_height_percentage number

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

facet_fixed_cols boolean

Grid mode: fix columns. Turn on to specify the number of columns in the charts grid.

facet_cols number

Number of columns in charts grid. How many columns of charts there should be in the grid.

Min: 1

facet_min_w number

Min chart width in charts grid. Determines how many columns of charts there are in the grid.

Margins

margin_top number

Top.

margin_right number

Right.

margin_bottom number

Bottom.

margin_left number

Left.

Line styles

lines_show boolean

Shows lines. Enables lines drawn between dots with the same name

line_width number

Line width.

line_opacity number

Line opacity.

Max: 1

line_curve string

Line style.

Allowed values:

  • curveLinear (Straight)
  • curveNatural (Curve (Natural))

line_color_mode string

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

Allowed values:

  • by_dot (Match dots)
  • fixed (Fixed)

line_color color

Colour.

X axis

x_type string

Data type.

Allowed values:

  • auto (Auto)
  • number (Number)
  • discrete (Category)

x_axis_sort_categories boolean

Sort axis when showing categories.

x_axis_label string

X axis label.

x_axis_min number

X min.

x_axis_max number

X max.

x_axis_matching boolean

Matching X axis across charts grid.

x_axis_log boolean

Log scale. Ignored if axis is showing categories rather than numbers

x_axis_show boolean

Show x axis.

x_axis_padding_left number

X axis padding. Horizontal space between the y and x axes

x_axis_show_domain boolean

Line at bottom.

x_axis_num_ticks number

Number of tick marks. Approximate. The actual number will depend on the range of values, chart size, etc.

x_axis_tick_dashed number

Tick dash size. Zero for a solid line, bigger numbers for bigger dashes

x_axis_color color

Text colour.

x_axis_tick_color color

Tick colour.

x_axis_tall_ticks boolean

Tick marks full height.

x_axis_ticks_inline boolean

Tick labels next to line.

x_axis_prefix string

Number prefix. Optional text (e.g. currency symbol) to include before the axis tick marks

x_axis_suffix string

Number suffix. Optional text (e.g. units) to include after the axis tick marks

Y axis

y_type string

Data type.

Allowed values:

  • auto (Auto)
  • number (Number)
  • discrete (Category)

y_axis_sort_categories boolean

Sort axis when showing categories.

y_axis_label string

Y label.

y_axis_min number

Y min.

y_axis_max number

Y max.

y_axis_matching boolean

Matching Y axis across charts grid.

y_axis_log boolean

Log scale. Ignored if axis is showing categories rather than numbers

y_axis_show boolean

Show y axis.

y_axis_show_domain boolean

Line at edge.

y_axis_num_ticks number

Number of tick marks. Approximate. The actual number will depend on the range of values, chart size, etc.

y_axis_tick_dashed number

Tick dash size. Zero for a solid line, bigger numbers for bigger dashes

y_axis_color color

Text colour.

y_axis_tick_color color

Tick colour.

y_axis_wide_ticks boolean

Tick marks full width.

y_axis_ticks_inline boolean

Tick labels above line.

y_axis_prefix string

Number prefix. Optional text (e.g. currency symbol) to include before the axis tick marks

y_axis_suffix string

Number suffix. Optional text (e.g. units) to include after the axis tick marks

Labels

labels_show boolean

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

label_color_type string

Label colour.

Allowed values:

  • auto (Match dots)
  • fixed (Fixed)

label_color color

Fixed.

labels_responsive boolean

Scale label with chart.

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

show_popups boolean

Show popups.

Text colour.

Backgro… colour.

Backgro… opacity.

Font size.

Min: 1

Custom popup contents.

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 used can include HTML to apply layouts, formatting, images, etc.

Filter

filter_type string

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

Allowed values:

  • auto-buttons (Auto)
  • dropdown (Dropdown)
  • grouped-buttons (Grouped buttons)
  • floating-buttons (Buttons)

Time slider

slider_play boolean

Show play button.

slider_step_time number

Time per step. In seconds; in general it’s best to avoid setting this to be shorter than the animation duration

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

Trend lines

fit_type string

Lines to show.

Allowed values:

  • none (None)
  • both (One per discrete colour)
  • color (One per discrete colour (same across charts grid))
  • chart (One for all colours)
  • all (One for all colours (same across charts grid))

fit_force_origin boolean

Force line through origin.

fit_line_width number

Width.

fit_line_dash number

Dash.

fit_line_color color

Colour.

Box plot

box_plot boolean

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

box_color color

Box colour.

box_opacity number

Box opacity.

Max: 1

box_line_color color

Line colour.

box_line_width number

Line width.

box_whisker_type string

Whisker type.

Allowed values:

  • tukey (Exclude outliers)
  • all (All dots)

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

Annotations

anno_x_enabled boolean

Show highlights on the x axis.

anno_x_lines text

One per line, in format “Thing :: 28000”.

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

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.

Allowed values:

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

anno_y_enabled boolean

Show highlights on the y axis.

anno_y_lines text

One per line, in format “Thing :: 6”.

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

anno_y_fill_color color

Area.

anno_y_label_color color

Text.

anno_y_fill_opacity number

Area opacity.

anno_y_label_align string

Labels.

Allowed values:

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

Animations

animation_duration number

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

animation_stagger number

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

footer.source_name string

Source name.

footer.source_url string

Source url.

footer.multiple_sources boolean

Multiple sources.

footer.source_name_2 string

Source name.

footer.source_url_2 string

Source url.

footer.source_name_3 string

Source name.

footer.source_url_3 string

Source url.

footer.source_label string

Source label.

footer.note string

Note.

footer.size number

Size.

footer.color color

Color.

footer.align string

Alignment.

Allowed values:

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

footer.margin number

Overall.

footer.margin_top number

Top.

footer.margin_right number

Right.

footer.margin_bottom number

Bottom.

footer.margin_left number

Left.

footer.margin_advanced boolean

Advanced.