Scatter

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

Updated 8 days ago to v6.1.0 by Flourish team

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: @flourish/scatter

version: 6

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: "@flourish/scatter",
    version: "6",
    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: "6",
    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.)

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: "6",
data: {
    data: [
        {
            name: [...],
            metadata: [...]
        },
        ...
    ]
},
...
}

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

{
template: "@flourish/scatter",
version: "6",
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

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)

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

Min: 1

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.

fill_opacity number

Dot opacity.

Max: 1

stroke_opacity number

Outline opacity.

Max: 1

stroke_width number

Outline width.

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.

Allowed values:

  • svg (SVG)
  • webgl (WebGL (beta))

Dot colours

color_type string

Data type.

Allowed values:

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

color.palette colors

Palette.

color.extend boolean

Auto-extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once. Added colours are based on the average lightness and chroma values of the palette. This works best if the palette’s colours do not have very high or low saturation.

color.advanced boolean

Fine tune. Fine tune how additional colours are added to the palette.

color.hue_rotation_angle number

Hue rotation for added colours. Angle, in degrees in HCL colourspace, between one generated colour and the next. The default value, ~360/(Golden ratio), ensures adjacent hues are not too similar.

Max: 360

color.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:<br /><hr />Party 1: red<br />Party 2: #4455AA<br />Party 3: rgb(30,168,26)

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.

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

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.

Allowed values:

  • false (All)
  • true (Selective (story only))

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

label_align string

Allowed values:

  • auto (Auto)
  • start (fa-align-left)
  • middle (fa-align-center)
  • end (fa-align-right)

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

Allowed values:

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

facet_aspect number

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

facet_bg_color_enabled boolean

Colour. Affects the chart only. To set the background across the whole layout, look in the Layout settings panel.

Allowed values:

  • false (Off)
  • true (On)

facet_bg_image_enabled boolean

Image. Affects the chart only. To set the background across the whole layout, look in the Layout settings panel.

Allowed values:

  • false (Off)
  • true (On)

facet_bg_color color

Colour.

facet_bg_image url

Image url.

facet_bg_image_opacity number

Image opacity.

Max: 1

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.

Min: 1

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.

Allowed values:

  • auto (Auto)
  • left (fa-align-left)
  • center (fa-align-center)

facet_header_color color

Colour.

Lines & arrows

lines_show boolean

Shows lines.

line_width_responsive boolean

Line width.

Allowed values:

  • true (Auto)
  • false (Fixed)

line_width_min number

Min size.

line_width_max number

Max size.

line_width number

Line width.

line_curve string

Line style.

Allowed values:

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

line_opacity number

Line opacity.

Max: 1

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.

line_arrows boolean

Arrow heads on lines.

line_arrow_size number

Size.

line_arrow_color_mode string

Colour mode.

Allowed values:

  • auto (Auto)
  • fixed (Fixed)

line_arrow_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 label.

x_axis_label_font_size number

Text size. In rems

x_axis_min number

X min. Ignored if axis is showing categories rather than numbers

x_axis_max number

X max. Ignored if axis is showing categories rather than numbers

x_axis_log boolean

Log scale.

x_axis_matching boolean

Matching x axis across grid of charts.

x_axis_last_row_only boolean

Only show X axis on last grid row.

x_axis_tick_style string

Allowed values:

  • ticks (Ticks)
  • gridlines (Gridlines)
  • none (None)

x_axis_ticks_inline boolean

Labels on gridlines.

x_axis_tick_font_size number

Label font size.

x_axis_tick_h number

Label height. Vertical size of the tick or gridline labels, in rems

x_axis_tick_angle string

Label angle.

Allowed values:

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

x_axis_color color

Label color.

x_axis_num_ticks number

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

x_axis_tick_dashed number

Dashes. Zero for a solid line, bigger numbers for bigger dashes

x_axis_tick_color color

Lines.

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)

Min: -10

Max: 10

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

Allowed values:

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

x_formatting.multiply_divide_constant number

x_formatting.exponentiate_constant number

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

Text size. In rems

y_axis_min number

Y min.

y_axis_max number

Y max.

y_axis_log boolean

Log scale.

y_axis_matching boolean

Matching y axis across grid of charts.

y_axis_first_col_only boolean

Only show Y axis on first column of grid.

y_axis_tick_style string

Allowed values:

  • ticks (Ticks)
  • gridlines (Gridlines)
  • none (None)

y_axis_ticks_inline boolean

Labels above lines.

y_axis_tick_font_size number

Label font size. In rems

y_axis_tick_w number

Label width. Horizontal space for the axis tick labels in rems

y_axis_color color

Label colour.

y_axis_num_ticks number

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

y_axis_tick_dashed number

Dashes. Zero for a solid line, bigger numbers for bigger dashes

y_axis_tick_color color

Lines.

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)

Min: -10

Max: 10

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

Allowed values:

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

y_formatting.multiply_divide_constant number

y_formatting.exponentiate_constant number

Legend

legend_position string

Legend position.

Allowed values:

  • above (Above)
  • below (Below)
  • off (Off)

categorical_legend.show_legend boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

categorical_legend.text_color color

Color.

categorical_legend.text_size number

Size.

categorical_legend.title string

Title.

categorical_legend.title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Normal)

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

Orientation.

Allowed values:

  • horizontal (Horizontal)
  • vertical (Vertical)

text_legend string

Allowed values:

  • auto (Auto)
  • custom (Custom)
  • off (Off)

text_legend_title boolean

Title.

text_legend_subtitle boolean

Subtitle.

text_legend_bold boolean

Bold. If checked, always use bold for coloured items

Popups

popup.show_popups boolean

Popups.

Allowed values:

  • true (Enabled)
  • false (Disabled)

popup.is_custom boolean

Popup contents.

Allowed values:

  • false (Auto)
  • true (Custom content)

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.

Allowed values:

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

popup.font_size number

Font size.

Min: 1

popup.fill_color color

Fill colour.

popup.opacity number

Fill opacity.

Max: 1

popup.padding number

Padding.

popup.border_radius number

Radius. Corner radius of popup

color_popup_headings boolean

Color popup headings.

Filter

filter.type string

Data type.

Allowed values:

  • categorical (Categories)
  • temporal (Dates/times)
  • numeric (Numbers)

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

Predefined values:

  • %Y-%m-%dT%H:%M:%S.%LZ (1986-01-28T11:39:13.000Z)
  • %Y-%m-%d (1986-01-28)
  • %m/%d/%Y (01/28/1986)
  • %d-%b-%y (28-Jan-86)
  • %m/%Y (01/1986)
  • %b %Y (Jan 1986)
  • %B %d (January 28)
  • %d %b (28 Jan)
  • %Y (1986)
  • %B (January)
  • %b (Jan)
  • %A (Tuesday)
  • %a (Tue)
  • %X (11:39:13)
  • %H:%M %p (11:39 AM)
  • %H:%M (11:39)

filter.sort boolean

Sort menu.

filter.control string

Control.

Allowed values:

  • auto (Auto)
  • dropdown (Dropdown menu)
  • grouped-buttons (Button group)

filter.width number

Menu width.

Min: 150

filter.play_button boolean

Include play button.

filter.step_time number

Time between steps when playing. Measured in seconds, positive values move the slider left to right, negative values move the slider right to left.

filter.loop boolean

Loop on play.

filter.restart_pause number

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

filter.dropdown_icon_color color

Icon color.

filter.slider_handle_color color

Handle and button color.

filter.slider_track_color color

Track and label color.

filter_show_all boolean

Include "All".

filter_show_all_text string

“All” label.

filter_updates_axes boolean

Update axes when filtering.

Time slider

slider.type string

Data type.

Allowed values:

  • categorical (Categories)
  • temporal (Dates/times)
  • numeric (Numbers)

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

Predefined values:

  • %Y-%m-%dT%H:%M:%S.%LZ (1986-01-28T11:39:13.000Z)
  • %Y-%m-%d (1986-01-28)
  • %m/%d/%Y (01/28/1986)
  • %d-%b-%y (28-Jan-86)
  • %m/%Y (01/1986)
  • %b %Y (Jan 1986)
  • %B %d (January 28)
  • %d %b (28 Jan)
  • %Y (1986)
  • %B (January)
  • %b (Jan)
  • %A (Tuesday)
  • %a (Tue)
  • %X (11:39:13)
  • %H:%M %p (11:39 AM)
  • %H:%M (11:39)

slider.sort boolean

Sort menu.

slider.control string

Control.

Allowed values:

  • auto (Auto)
  • dropdown (Dropdown menu)
  • slider (Slider)
  • grouped-buttons (Button group)
  • floating-buttons (Buttons)

slider.width number

Menu width.

Min: 150

slider.play_button boolean

Include play button.

slider.step_time number

Time between steps when playing. Measured in seconds, positive values move the slider left to right, negative values move the slider right to left.

slider.loop boolean

Loop on play.

slider.restart_pause number

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

slider.dropdown_icon_color color

Icon color.

slider.slider_handle_color color

Handle and button color.

slider.slider_track_color color

Track and label color.

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.

Max: 1

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, violin and beeswarm plots

beeswarm_plot boolean

Show beeswarm when plotting one numerical and one categorical axis.

Allowed values:

  • true (Yes)
  • false (No)

box_plot boolean

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

Allowed values:

  • true (Yes)
  • false (No)

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

violin_plot boolean

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

Allowed values:

  • true (Yes)
  • false (No)

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.

Min: 10

Max: 250

violin_color color

Colour.

violin_opacity number

Opacity.

Max: 1

violin_sizing string

Sizing mode.

Allowed values:

  • area (Same area)
  • width (Same max width)

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.

Max: 1

anno_x_label_align string

Labels.

Allowed values:

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

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

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.

Max: 1

anno_y_label_align string

Align.

Allowed values:

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

anno_y_label_font_size number

Font size. In rems

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.

Allowed values:

  • . (.)
  • , (,)

localization.output_separators string

Number format to display. How the numbers should appear on chart labels

Allowed values:

  • ,. (12,235.67)
  • ., (12.345,67)
  • . (12235.67)
  • , (12345,67)
  • . (12 235.67)
  • , (12 345,67)

Layout

layout.body_font font

Font.

layout.max_width number

Maximum width. Leave blank to stretch to container width

Min: 50

layout.background_color_enabled boolean

Color.

Allowed values:

  • true (On)
  • false (Off)

layout.background_image_enabled boolean

Image.

Allowed values:

  • true (On)
  • false (Off)

layout.background_color color

Color.

layout.background_image_src url

Image URL.

layout.background_image_size string

Size.

Allowed values:

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

layout.background_image_position string

Position.

Allowed values:

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

layout.layout_order string

Layout order.

Allowed values:

  • stack-default (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAANhJREFUSA3tVNEOwiAM7Iy/p2/wkTz6g5gjOVZZEepcjMmWLBTau95ugIh6lpzzLcb4wNpFJaRk9MIahxAyXmD7mC7BC2RlFbliQjFMpJTujOdGs/ECwRoP3rlKoEzNJlz3+CwutK0NLRVt2QhjggA9n2IGEKANMxmt0VVsEfxgzfX7zL3ZiqbXLjcKc8vEORk5/75mMB/7u11uuIpdbtDCc5R3l/s+e+pmHt1foza7Nv6IXOeHiqGk9zWtSk1cN2cPrItnYjZzHZEZYtacxHTiuANSO/xN8AS4uW8Rw1Gu2AAAAABJRU5ErkJggg==)
  • stack-2 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAAMpJREFUSA3tVMsKwyAQNKW/l970Iz32Bw0jjKTrSLUY0oOBsO5rnOwYnTs9W0ppDyG8EcsOkw8uauu9T3jR2+75yJxBnnC4JxMxxlezg0V9VsJsIGz75TfKdlkpg3aPcT8TsPNRMJjZEIf5xaAAahUyE+RtfcZvtFLoFh95aFXxH4hCWpUoTCg7fxqUfB4yEcl/CJlNy5qbfuZA8m8CwJ77q2djSj50lnuAWbOAOQlXxCuRHxcUje2XzfgrYzBpHUXLkmxh181SpnEAB4Vg0DSGhHsAAAAASUVORK5CYII=)
  • stack-3 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAANFJREFUSA3tVEEOwyAMo9O+193gkRz3QSZHMmNRUkGp1guVqkCIHZMAITTfVkrZU0pv+B7NQpCV1vEdxxgLfmB9jEvwBBNzkjXn/HIRDOqzJs0GwS1eEmonAn52RITJaUYScd5KLl0fTQf58HVpIFlXMDPNBVMf2TDXPq7dZM2eelrMQ6uDucG50mlWzG/ooCWDvqENXldn1pcyhpgJWjYcPe5z5ZFrAgoe2LN0f2v1ZYq5UyofuiME99hFXKtUm1c9aoBmeEeRjVIQma6XpVblAwnpZjN/VjqsAAAAAElFTkSuQmCC)
  • stack-4 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAANtJREFUSA3tVNEOwjAI3Iy/p2/tR/bRH6zekmuA1glO45bYZAHKcdDCOk1izbXWC+0zlJzzDVJ5sNGW9qSUKj4QKY8yWvBDUWnoKKVcTzS2yWHiIfeMwm2yIbLbRL3DRJYubi+0bAPCkcvapO3AdFgZvuDuyJZR2i4wSpBBP9ZD7RsOLQ9gD/Y5ZmaA3EEHWY6r3SEwrzDEHLpnlvOXa4/7xttZfhNwyPdKcqLPaz6JlXpr9bNgCfbobw2ch5iY0CQzyCOPR9ya5zleBPNy3LxknAbiv1YxExxH3gEqBW7I4zw3PQAAAABJRU5ErkJggg==)

layout.space_between_sections string

Space between sections.

Allowed values:

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

layout.space_between_sections_custom number

Custom.

Max: 100

layout.margin_top number

Top.

layout.margin_right number

Right.

layout.margin_bottom number

Bottom.

layout.margin_left number

Left.

layout.border.enabled boolean

Show borders around visualisation.

layout.border.top.width number

Top.

layout.border.top.style string

Style.

Allowed values:

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

layout.border.top.color color

Color.

layout.border.right.width number

Right.

layout.border.right.style string

Style.

Allowed values:

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

layout.border.right.color color

Color.

layout.border.bottom.width number

Bottom.

layout.border.bottom.style string

Style.

Allowed values:

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

layout.border.bottom.color color

Color.

layout.border.left.width number

Left.

layout.border.left.style string

Style.

Allowed values:

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

layout.border.left.color color

Color.

layout.header_align string

Alignment.

Allowed values:

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

layout.title string

layout.title_styling boolean

Styling.

layout.title_size string

Size.

Allowed values:

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

layout.title_size_custom number

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

layout.title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.title_color color

Color.

layout.title_line_height number

Line height.

Max: 3

layout.title_space_above string

Space above.

Allowed values:

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

layout.title_space_above_custom number

Custom.

Max: 100

layout.subtitle string

layout.subtitle_styling boolean

Styling.

layout.subtitle_size string

Size.

Allowed values:

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

layout.subtitle_size_custom number

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

layout.subtitle_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.subtitle_color color

Color.

layout.subtitle_line_height number

Line height.

Max: 3

layout.subtitle_space_above string

Space above.

Allowed values:

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

layout.subtitle_space_above_custom number

Custom.

Max: 100

layout.text string

layout.text_styling boolean

Styling.

layout.text_size string

Size.

Allowed values:

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

layout.text_size_custom number

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

layout.text_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.text_color color

Color.

layout.text_line_height number

Line height.

Max: 3

layout.text_space_above string

Space above.

Allowed values:

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

layout.text_space_above_custom number

Custom.

Max: 100

layout.header_border string

Allowed values:

  • top (Top)
  • bottom (Bottom)
  • none (None)

layout.header_border_width number

Width.

layout.header_border_color color

Color.

layout.header_border_style string

Style.

Allowed values:

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

layout.header_logo_enabled boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

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

Allowed values:

  • outside (Outside)
  • inside (Inside)

layout.header_logo_position_inside string

Position.

Allowed values:

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

layout.header_logo_position_outside string

Position.

Allowed values:

  • left (Left)
  • right (Right)

layout.header_logo_margin_top number

Top.

layout.header_logo_margin_right number

Right.

layout.header_logo_margin_bottom number

Bottom.

layout.header_logo_margin_left number

Left.

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

Size.

layout.footer_text_color color

Color.

layout.footer_align string

Alignment.

Allowed values:

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

layout.footer_logo_enabled boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

layout.footer_logo_src url

Image.

Link.

layout.footer_logo_height number

Height.

layout.footer_logo_margin number

Margin.

layout.footer_logo_order string

Position.

Allowed values:

  • left (Left)
  • right (Right)

layout.footer_align_vertical string

V. align.

Allowed values:

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

layout.footer_border string

Allowed values:

  • top (Top)
  • bottom (Bottom)
  • none (None)

layout.footer_border_width number

Width.

layout.footer_border_color color

Color.

layout.footer_border_style string

Style.

Allowed values:

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