Sankey diagram

Sankey visualisation

Updated 2 hours ago to v10.7.4 by Flourish team

How to use this template

Sankey diagram

A template for creating Sankey diagrams and alluvial diagrams. Ideal for displaying energy flows or the changes in seats between parties from before to after an election.

Data requirements

The template works with two types of data format:

  1. Flows are already in the data, and each row has a source name, target name and flow value (plus optional step from and step to columns for multistep alluvial diagrams).

  2. Flows are not already in the data. In this model, each row is a entity (e.g. a seat in an election), with a source name and target name (e.g. representing the ruling party before and after the election). With this kind of data the flows are computed automatically by adding up source–target pairs (taking into account step from and step to values).

FAQ

How can I specify the ordering of the results? They're shown in a different order from my raw data In the settings panel, set "Iter" to 0.

Tips

  • If specifying flow values directly, the column used for Value of link must contain positive numbers or zero
  • Names are compared and values summed using case-insensitive comparisons with all non-alphanumeric characters stripped. For example “Cat“ and “cA ?t“ are considered identical.
  • Hovering over a link will defocus all other links and any node not connected to that link. Hovering over a node will defocus all links that are not directly connected to that node and all nodes not connected via a link to the hovered node. You can fix focus on a node or link and all its connections by clicking on the entity. This is particularly useful for guiding viewers through your stories. Click a focused node or link again to remove the focus or click any other node or link to change focus to that entity.
  • The optional Step from and Step to column selection boxes make it possible to construct multistep alluvial diagrams where links go from Step from to Step to along the horizontal direction. If only Step from is assigned to a column then the value of Step to is assumed to be one greater than that of Step from. Similarly, if only Step to is assigned to a column then the value of Step from is assumed to be one less than that of Step to.

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/sankey

version: 10

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/sankey",
    version: "10",
    bindings: {
        data: {
            source: 0, // index of a column in your data
            target: 1, // index of a column in your data
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@flourish/sankey",
    version: "10",
    bindings: {
        data: {
            source: 0, // index of a column in your data
            target: 1, // index of a column in your data
            value: 2, // index of a column in your data
            filter: 3, // index of a column in your data
            facet: 4, // index of a column in your data
            step_from: 5, // index of a column in your data
            step_to: 6, // index of a column in your data
            metadata: [7, 8, ...], // index(es) of column(s) in your data
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

2. Array of objects with arbitrary keys, and a bindings object

This format is most likely useful when you have data from an external source, such as CSV data loaded from d3-dsv. You should supply this attached to the opts.data, which might look like:

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

... but with the keys being the column headers from your source data instead. You must also supply an object attached to opts.bindings. The minimal bindings you can supply for this template are as shown in this example:

{
    template: "@flourish/sankey",
    version: "10",
    bindings: {
        data: {
            source: "DataHeader1",
            target: "DataHeader2",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/sankey",
    version: "10",
    bindings: {
        data: {
            source: "DataHeader1",
            target: "DataHeader2",
            value: "DataHeader3",
            filter: "DataHeader4",
            facet: "DataHeader5",
            step_from: "DataHeader6",
            step_to: "DataHeader7",
            metadata: ["DataHeader8", "DataHeader9", ...],
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

3. Array of objects with template-defined keys

There is an alternative format you can use, which is likely to be easier to use if your data is not from a spreadsheet source. With this alternative format you supply your data to the template as an array of objects, attached to opts.data, where the keys must be those used by the template, as documented below. In this case there is no need to supply a bindings object, since the key names are already those expected by the template. The required properties in the data object are as follows (scroll down for a description of what each property is):

{
    template: "@flourish/sankey",
    version: "10",
    data: {
    data: [
        {
            source: ...,
            target: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/sankey",
    version: "10",
    data: {
    data: [
        {
            source: ...,
            target: ...,
            value: ...,
            filter: ...,
            facet: ...,
            step_from: ...,
            step_to: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

  • data.source: source string
  • data.target: target string
  • data.value: A numerical value used to set the thickness of the links. number
  • data.filter: filter string, number, datetime
  • data.facet: facet string
  • data.step_from: An integer value used to indicate where a link starts from (used only in Alluvial mode). number
  • data.step_to: An integer value used to indicate where a link goes to (used only in Alluvial mode). number
  • data.metadata: One or more columns of information to be included in popups and panels. When multiple rows are aggregated into one link, only the popup content of the first row will be shown. number, datetime, string

Template metadata

Note: metadata is optional, and the API will interpret your data for you if you do not specify it. A typical example of when specifying metadata can be useful is when column(s) in your data contain numbers or dates that you wish to format visually (e.g. to display a column containing MM/DD/YYYY dates in DD/MM/YYYY format).

This template supports an optional metadata property. metadata informs the template what type of data is in each of your columns, and how that data should be formatted visually.

You can specify metadata in one of three formats, depending on the format of opts.data.

1. Array of objects with column indexes as keys

You should supply metadata in this format when opts.data is in the previously described 'array of arrays' format. In this case, metadata should be an object with column index: column type object key/value pairs (column type objects must have type, type_id, and output_format_id keys, documented below):

{
    template: "@flourish/sankey",
    version: "10",
    ...
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    },
    metadata: {
        data: {
            0: { type: ..., type_id: ..., output_format_id: ... },
            1: { type: ..., type_id: ..., output_format_id: ... },
        }
    },
    ...
}

2. Array of objects with column headers as keys

You should supply metadata in this format when opts.data is in the previously described 'array of objects with arbitrary keys' format. In this case, metadata should be an object with column header: column type object key/value pairs (column type objects must have type, type_id, and output_format_id keys, documented below):

{
    template: "@flourish/sankey",
    version: "10",
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    },
    metadata: {
        data: {
            "DataHeader1": { type: ..., type_id: ..., output_format_id: ... },
            "DataHeader2": { type: ..., type_id: ..., output_format_id: ... },
        }
    },
    ...
}

Column type objects:

Column type objects tell the API what type of data is in a column:

{
    type: "number", // options also include 'string', and 'datetime'
    type_id: "number$comma_point", // numbers in the format 13,429.17
    output_format_id: "number$space_comma", // numbers in the format 13 429,17
}

For more information on valid column type values, see Recognized Type Formats.

Template settings

Options for opts.state.

Mode & setup

mode string

Mode.

Allowed values:

  • alluvial (Alluvial (step-by-step))
  • sankey (Sankey (arbitrary flows))

spread string

Spread.

Allowed values:

  • step (Based on step values)
  • column (Evenly)

alignment string

Alignment.

Allowed values:

  • justify (Justify)
  • center (Centre)
  • left (Left)
  • right (Right)

sorting_mode string

Sorting. "Match sheet" sorts based on the order of the categories as they appear in the datasheet. "Value" sorts by the value of the nodes at each stage. "Reduce overlaps" reduces the overlapping of links.

Allowed values:

  • datasheet (Match sheet)
  • name (Name)
  • value (Value)
  • reduce_overlaps (Reduce overlaps)

node_sort_order string

Order.

Allowed values:

  • ascending (Ascending)
  • descending (Descending)

iterations number

Iterations. Number of iterations of the layout algorithm before the diagram is drawn. The higher the value, the fewer link crossings you will see but the less likely the order is to match that in the datasheet.

Min: 1

Max: 100

setup_settings boolean

Advanced.

node_width number

Node width.

Max: 50

node_padding number

Node spacing. The vertical gap between nodes

Max: 20

top_padding number

Margin above. Adds space at the top of the diagram; useful to accommodate any overflowing labels

Max: 50

bottom_padding number

Margin below. Adds space at the bottom of the diagram; useful to accommodate any overflowing labels

Max: 50

height_mode string

Height mode. Whether responsive embeds should set their own height or use the "standard" responsive Flourish embed heights. Ignored in simple iframe embeds, Canva and other fixed-height contexts.

Allowed values:

  • aspect (Aspect ratio)
  • standard (Standard)

facet_aspect number

Aspect. Aspect ratio of each plot in desktop mode, where 1 is square, above 1 is wider, and below 1 is taller.

Min: 0.01

Grid of charts

facets.columns_fixed boolean

Number of columns. In <b>Auto</b> mode, the number of columns will change with screen size

Allowed values:

  • false (Auto)
  • true (Fixed)

facets.min_width number

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

facets.max_width number

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

facets.columns number

Fixed number of columns.

Min: 1

facets.gutter_w number

Horizontal margin.

facets.gutter_h number

Vertical margin.

facets.animation string

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

Allowed values:

  • auto (Auto)
  • name (Remove)
  • reuse (Reuse)

facets.titles boolean

Show titles.

facets.title_align string

Alignment.

Allowed values:

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

facets.title_size number

Size. Relative to the width of the chart

facets.title_unit string

Scale with chart.

Allowed values:

  • rem (Off)
  • facet (On)

facets.title_color color

Color.

facets.title_padding_top number

Space above.

facets.title_padding_bottom number

Space below.

facets.title_bg string

Background.

Allowed values:

  • none (None)
  • full (Full)
  • text (Text)

facets.title_bg_color color

Color.

facets.title_bg_padding number

Padding. Horizontal space between text and background

facets_hide_empty boolean

Hide empty charts when filtering.

Colors

color.categorical_palette colors

Palette.

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. Enter the label name for which you wish to set the color, followed by a colon and the desired color value. <br><br><a href="https://help.flourish.studio/article/458-how-to-customize-colors-in-flourish-palettes#:~:text=The%20main%20color%20tool%20in,delete%20and%20add%20new%20colors">Colors can be set</a> using Hex, RGB, color names or RGBA, if you want to set the <a href="https://help.flourish.studio/article/393-add-transparency-to-flourish-colors">opacity</a>. Multiple colors can be set using multiple lines. For example: <br /><hr />Party 1: red <br />Party 2: #4455AA <br />Party 3: rgb(30,168,26)

color.numeric_type string

Scale type.

Allowed values:

  • sequential (Sequential)
  • diverging (Diverging)

color.binning boolean

In <b>linear</b> mode, the color scale will run as a smooth gradient between 2 colors. In <b>binned</b> mode, the gradient will be divided in smaller blocks.

Allowed values:

  • false (Linear)
  • true (Binned)

color.bin_mode string

Binning mode.

Allowed values:

  • fixed (Fixed width)
  • quantile (Quantile)
  • custom (Custom thresholds)

color.bin_count number

Number of bins.

color.bin_thresholds string

Custom thresholds. Enter your desired thresholds, separating them with a ";". For instance, "5;10;15". <br><br>Bins form as follows: <ul> <li>From the data's minimum value (domain minimum) up to the first threshold.</li> <li>Between consecutive thresholds.</li> <li>From the last threshold to the data's maximum value (domain maximum).</li> <ul> </br>For "5;10;15", you'll get four bins based on your data's range.

color.sequential_palette string

Palette.

Allowed values:

  • Oranges (Oranges)
  • Reds (Reds)
  • Blues (Blues)
  • Greens (Greens)
  • Greys (Greys)
  • Purples (Purples)
  • Viridis (Viridis)
  • Inferno (Inferno)
  • Magma (Magma)
  • Plasma (Plasma)
  • Warm (Warm)
  • Cool (Cool)
  • CubehelixDefault (Cubehelix)
  • BuGn (Blue/Green)
  • BuPu (Blue/Purple)
  • GnBu (Green/Blue)
  • OrRd (Orange/Red)
  • PuBuGn (Purple/Blue/Green)
  • PuBu (Purple/Blue)
  • PuRd (Purple/Red)
  • RdPu (Red/Purple)
  • YlGnBu (Yellow/Blue/Green)
  • YlGn (Yellow/Green)
  • YlOrBr (Yellow/Orange/Brown)
  • YlOrRd (Yellow/Orange/Red)
  • Carrots
  • Custom

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.

Allowed values:

  • rgb (RGB)
  • lab (LAB)
  • hcl (HCL)
  • hsl (HSL)

color.sequential_custom_domain boolean

Domain.

Allowed values:

  • false (Auto)
  • true (Custom)

color.sequential_domain_min number

Min.

color.sequential_domain_max number

Max.

color.diverging_palette string

Palette.

Allowed values:

  • RdBu (Red/Blue)
  • RdYlGn (Red/Yellow/Green)
  • PiYG (Pink/Yellow/Green)
  • BrBG (Brown/Blue/Green)
  • PRGn (Purple/Red/Green)
  • PuOr (Purple/Orange)
  • RdGy (Red/Grey)
  • RdYlBu (Red/Yellow/Blue)
  • Spectral (Spectral)
  • Custom

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.

Allowed values:

  • rgb (RGB)
  • lab (LAB)
  • hcl (HCL)
  • hsl (HSL)

color.diverging_custom_domain boolean

Domain.

Allowed values:

  • false (Auto)
  • true (Custom)

color.diverging_domain_min number

Min.

color.diverging_domain_mid number

Mid.

color.diverging_domain_max number

Max.

Link opacity.

Max: 1

background_opacity number

Defocused opacity. When a node or link is in focus, this sets the opacity of the others

Max: 1

custom_node_color color

Custom node color.

Links color mode.

Allowed values:

  • node (By node)
  • source (By source)
  • target (By target)

Labels

label_mode string

Position.

Allowed values:

  • outwards (Favor outside)
  • inwards (Favor inside)

label_outwards_max_width number

Space. The max space available for the labels, as a percentage of total width

Max: 40

label_color_mode string

Color mode.

Allowed values:

  • auto (Match data)
  • fixed (Fixed)

label_color color

Color.

label_bold boolean

Bold.

label_show_values boolean

Include values.

Show link values.

Allowed values:

  • never (Never)
  • focused (Focused)
  • always (Always)

Colour.

label_outline boolean

Outline.

Allowed values:

  • true (On)
  • false (Off)

label_outline_width number

Width. As a percent of the font size

Max: 100

label_font_size number

Font size. In rems, a multiple of base font size

Max: 3

label_facet_scaling boolean

Scale with grid. Sets a max size based on the facet size, regardless of the page width

Step headings

show_node_headings boolean

Show headings. Enables the labels above each "column" of nodes an Alluvial diagram

node_headings_bold boolean

Bold.

node_headings_font_size number

Font size.

node_headings_padding number

Padding.

node_headings_max_width number

Max width.

node_headings_color color

node_headings_overrides text

Custom overrides. On each line, type the step heading that you want to override, a double colon and then the replacement step heading. For example:<br /><hr />1 :: Phase A<br />2 :: Phase B

Controls

filter_controls.control_type string

Control type. Choose between a <b>dropdown</b>, <b>buttons</b> or a <a href="https://help.flourish.studio/article/524-how-to-add-a-time-slider-to-your-line-bar-pie-chart"><b>time slider</b></a>.

Allowed values:

  • dropdown (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAC0AAAAKCAYAAAFXtOeCAAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAALaADAAQAAAABAAAACgAAAAAWgdR+AAAAtklEQVQ4EdVV3QnEIAw25TbSB2foNI7iMu0MbuUR4ZOQy4OFCL2AmN8vMQallNLVez+DosNSsg/FGLtyDkR0H1rJMqOMiJxz4KWp1jpUsLNsptCBkD/MlFIgzx3IsD9GflTGTLvImN1ajP1x043dVrlr1fIY4xZZYd2kdATfWgu8NCEedtdWcJ+R1BVYnmIbsEzizW8bDO9CJd4cOijxCEH22DGIq1iyBiv2P8eDP4jVDrzE7/oCOyRFCckULykAAAAASUVORK5CYII=)
  • buttons (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAAKCAYAAAFaqpfFAAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAK6ADAAQAAAABAAAACgAAAACxtWN2AAAA5klEQVQ4EdVUwQ2DMAwkqBuFBzO0y2QUlqEz5AEzpTrUiyzLEEPbRy2F2D7n4tgWYRiGuZRy75T0lhMxIcZYoKzrWvUeDi0VTSlt2DRN9dQ4jh0WBP4avHneH3kF/SGE5w0GWXPOHRaFfrDiEW5mEJjBZJY7UoPNakjM0s0KWYFnfa6MUbRlWR573daXurLlhHDXJNreugan7D2D0K09YUeJy467no+D1iyRUO+u5+tDLdudaYuIOEcQtncMeba1/6QCrUuv4nWwJIE1ZBKHLgdJY0f2J9z/NQb4cRxV4iQ2y/hvc78ACNVvxtjAMtcAAAAASUVORK5CYII=)
  • slider (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACkAAAAKCAYAAAFeX0f4AAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAKaADAAQAAAABAAAACgAAAABlifOxAAABz0lEQVQ4Ea1UvU7CUBSml05EHoBEB3gFGpg0fQE0Tk6suDC4uKBuxsXJ6BswGZaq0bnRqaR9CglPwEJCW79Dem5Of2iq8Sbk/H/349zTU7Msy6nhdLvdJUk+Ko7jk8RosbNcAupKZhjAjMkRBIHWG41GbTQayTzSP1IOIL32er3DlDMxTEI1DGPh+/4BSA7CMBxMp9N8LlAu2EtF+IVsS6m5maZpeZ4XcDApUGzX6/Wj+Xz+xXaZ1EWg59m2vSeSdYx8URRdili52u/394syqFlgu6TGFcV3+dRms/lGoS8TCAysP+FrUYN39U3WsG4mCmq2b3+Kt3cA9swJiVR4se1sZPw5kwEp8EBgpOD5fWJGOp/hcGiwXiap+atOp2MCTI8HZukY/ogLcUFqlNlfJHl8Vii6abfbj7PZrHDOuBiPNAH7W9hZxhFhgMwd5/6XZJIaDxeFIPHUbDavXddd6QAUmqJse2WcdNS/JV3Lhv5s50gyEi5bQB/jwhf2YcBoYZXuph3LhiF+LcHjXQ4kAQTYGudya0hUbIwzTL8LX+qjFznRer22MbyVtoqoK1UNPKGDy8cgRp2rdOi7p22Ep7eoAP/WV0rdV115lS4RST+YjrA2q0ehBQAAAABJRU5ErkJggg==)

filter_controls.control_styles boolean

Adv..

filter_controls.control_title string

Control title.

filter_controls.button_group boolean

Grouped.

Allowed values:

  • true (On)
  • false (Off)

filter_controls.button_group_width_mode string

Button group width.

Allowed values:

  • auto (Auto)
  • full (Full)
  • fixed (Fixed)

filter_controls.button_group_width_fixed number

Width.

Max: 100

filter_controls.dropdown_width_mode string

Dropdown width.

Allowed values:

  • auto (Auto)
  • full (Full)
  • fixed (Fixed)

filter_controls.dropdown_width_fixed number

Width.

Max: 100

filter_controls.slider_width number

Slider width. Width of the slider track in <a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">rems</a>

Max: 100

filter_controls.slider_max_label_width number

Max label width. In <a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">rems</a>, multiples of base font size. If larger than the longest label, only the space required to fit labels will be used.

Max: 100

filter_controls.slider_step_time number

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

Min: -100

Max: 100

filter_controls.slider_loop boolean

Loop.

filter_controls.slider_restart_pause number

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

Max: 100

filter_controls.sort boolean

Sorting.

Allowed values:

  • true (On)
  • false (Off)

filter_show_all boolean

Include "All".

filter_show_all_text string

“All” label.

controls_style.font_size number

Text size.

Max: 5

controls_style.font_weight string

Text weight.

Allowed values:

  • bold (Bold)
  • normal (Normal)

controls_style.height number

Height.

Max: 5

Background.

Text color.

Dropdown border styles.

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

Allowed values:

  • all (All sides)
  • bottom (Bottom)

Border width.

Max: 20

Color.

Transparency.

Max: 1

Radius.

Max: 100

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.

Max: 20

button_style.border_color color

Color.

button_style.border_transparency number

Transparency.

Max: 1

button_style.border_radius number

Radius.

Max: 100

slider_style.track_color color

Track.

slider_style.font_color color

Text.

slider_style.handle_color color

Handle.

slider_style.play_color color

Play/pause.

slider_style.track_height number

Track height.

Max: 1

slider_style.handle_height number

Height.

Max: 10

slider_style.play_button boolean

Play button.

Popups & panels

popup.mode string

Allowed values:

  • none (None)
  • popup (Popup)
  • panel (Panel)
  • both (Both)

popup.popup_is_custom boolean

Popup content.

Allowed values:

  • false (Auto)
  • true (Custom)

popup.show_popup_styles boolean

Show popup styles.

popup.popup_custom_header html

Popup custom header. Use {{LABEL}} to include the Label for the current element. For links, this will show in the format of "Source → Target", for nodes this will show the name of the node. For any other selected columns use {{column_name}}. Advanced users can include HTML to apply layouts, formatting, images, etc. <br><br> You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}} <br><br> If statements can also be used to show certain content for links only or nodes only. Use {{#if IS_LINK}} or {{#if IS_NODE}} like so: <br><br> <code>{{#if IS_LINK}} This is a link popup {{/if}}</code><br> <code>{{#if IS_NODE}} This is a node popup {{/if}}</code>

popup.popup_custom_main html

Popup custom main content. Use {{LABEL}} to include the Label for the current element. For links, this will show in the format of "Source → Target", for nodes this will show the name of the node. For any other selected columns use {{column_name}}. Advanced users can include HTML to apply layouts, formatting, images, etc. <br><br> You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}} <br><br> If statements can also be used to show certain content for links only or nodes only. Use {{#if IS_LINK}} or {{#if IS_NODE}} like so: <br><br> <code>{{#if IS_LINK}} This is a link popup {{/if}}</code><br> <code>{{#if IS_NODE}} This is a node popup {{/if}}</code>

popup.popup_custom_accessible text

Popup custom accessible content. A text alternative to visual custom popup content that will be read out by screenreaders. This content is added as an <code>aria-label</code> attribute to data point elements. You can still use {{column_name}} to add values from your data, but do not use HTML. For example: <code>{Name}}, Population: {{Population}}, GDP: {{GDP}}</code> If left empty, accessible content will fallback to the default popup content.

popup.popup_width number

Max width. In <a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">rems</a>, multiples of base font size. Leave blank to let the width adjust based on the contents.

popup.popup_font_size number

Text size.

popup.popup_text_color color

Text color.

popup.popup_align string

Align.

Allowed values:

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

popup.popup_background color

Fill color.

popup.popup_background_opacity number

Fill opacity.

Max: 1

popup.popup_padding number

Padding.

popup.popup_radius number

Radius. Corner radius of popup

popup.popup_header_type string

Header style.

Allowed values:

  • block (Header block)
  • inline (Header inline)

popup.popup_header_background color

Background.

popup.popup_header_text_color color

Text.

popup.popup_list_type string

List type.

Allowed values:

  • table (fa-table)
  • ul (fa-list)

popup.popup_list_label_weight string

Label weight.

Allowed values:

  • normal (Normal)
  • bold (Bold)

popup.popup_list_separator string

List separator.

Predefined values:

  • : (:)
  • (–)
  • (Empty space)
  • <br /> (Line break)

popup.popup_shadow boolean

Shadow.

popup.popup_pointer boolean

Pointer.

popup.panel_position string

Allowed values:

  • overlay (Overlay)
  • left (Left)
  • right (Right)
  • top (Top)
  • bottom (Bottom)

popup.panel_open_duration number

Open duration.

Max: 2000

popup.panel_side_fixed boolean

Always show.

popup.panel_side_default_content text

Placeholder content.

popup.panel_is_custom boolean

Panel content.

Allowed values:

  • false (Auto)
  • true (Custom)

popup.show_panel_styles boolean

Show panel styles.

popup.panel_custom_header html

Panel custom header. Use {{LABEL}} to include the Label for the current element. For links, this will show in the format of "Source → Target", for nodes this will show the name of the node. For any other selected columns use {{column_name}}. Advanced users can include HTML to apply layouts, formatting, images, etc. <br><br> You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}} <br><br> If statements can also be used to show certain content for links only or nodes only. Use {{#if IS_LINK}} or {{#if IS_NODE}} like so: <br><br> <code>{{#if IS_LINK}} This is a link panel {{/if}}</code><br> <code>{{#if IS_NODE}} This is a node panel {{/if}}</code>

popup.panel_custom_main html

Panel custom main content. Use {{LABEL}} to include the Label for the current element. For links, this will show in the format of "Source → Target", for nodes this will show the name of the node. For any other selected columns use {{column_name}}. Advanced users can include HTML to apply layouts, formatting, images, etc. <br><br> You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}} <br><br> If statements can also be used to show certain content for links only or nodes only. Use {{#if IS_LINK}} or {{#if IS_NODE}} like so: <br><br> <code>{{#if IS_LINK}} This is a link panel {{/if}}</code><br> <code>{{#if IS_NODE}} This is a node panel {{/if}}</code>

popup.panel_width_overlay number

Width (%).

popup.panel_height_overlay number

Height (%).

popup.panel_width_side number

Width (%).

popup.panel_height_side number

Height (%).

popup.panel_max_width number

Max width (px).

popup.panel_max_height number

Max height (px).

popup.panel_vertical_position string

Vertical position. Choosing <b>Click position</b> is especially useful when your visualization is really tall, this will make sure the panel content is always on top of the element you've clicked on

Allowed values:

  • click (Click position)
  • center (Center)

popup.panel_text_color color

Text color.

popup.panel_font_size number

Text size.

popup.panel_align string

Alignment.

Allowed values:

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

popup.panel_background color

Fill color.

popup.panel_background_opacity number

Fill opacity.

Max: 1

popup.panel_padding number

Padding.

popup.panel_radius number

Radius. Corner radius of panel

popup.panel_list_type string

List type.

Allowed values:

  • table (fa-table)
  • ul (fa-list)

popup.panel_list_label_weight string

Label weight.

Allowed values:

  • normal (Normal)
  • bold (Bold)

popup.panel_list_separator string

List separator.

Predefined values:

  • : (:)
  • (–)
  • (Empty space)
  • <br /> (Line break)

popup.panel_shadow boolean

Shadow.

Type.

Allowed values:

  • links (Links)
  • nodes (Nodes)
  • all (Links & nodes)

Animations

intro_duration number

Duration.

intro_ease_range number

Speed variation. When set at zero, all the links are revealed at an even speed. When set above zero, the lines randomly accelerate and decelerate slightly to give a more natural effect.

Max: 100

transition_duration number

Duration. In seconds

Number formatting

formatting.prefix string

Prefix. <a href="https://help.flourish.studio/article/37-how-to-change-number-formating">Text</a> to place in front of a number

formatting.suffix string

Suffix. <a href="https://help.flourish.studio/article/37-how-to-change-number-formating">Text</a> to place after a number

formatting.n_dec number

Decimal places. Decimal places. You can also enter a negative integer to <a href="https://help.flourish.studio/article/37-how-to-change-number-formating#multiply-divide">round to a whole number</a> with that many zeros. For example, -2 will round to the nearest hundred.

Min: -10

Max: 10

formatting.advanced boolean

Advanced.

formatting.negative_sign string

Styling of negative numbers.

Allowed values:

  • -$nk (-$100k)
  • $-nk ($-100k)
  • ($nk) (($100k))
  • $(n)k ($(100)k)
  • none ($100k)

formatting.strip_zeros boolean

Remove trailing zeros.

formatting.strip_separator boolean

Hide thousands separator below 10,000. Turn off if you want four-digit numbers to include a separator, e.g. “1,234” rather than “1234”.

formatting.transform_labels boolean

Multiply/divide values.

formatting.transform string

Allowed values:

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

formatting.multiply_divide_constant number

formatting.exponentiate_constant number

Layout

layout.body_font font

Main font. This font will apply to the whole graphic by default. 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, You can optionally change the color for individual text elements, in other settings panels.

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

Background 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.max_width_target string

Maximum width. Apply a <a href="https://help.flourish.studio/article/270-how-to-embed-a-visualization-with-a-maximum-width">maximum width</a> to just the <b>main graphic</b> or <b>everything</b> (main graphic plus header, footer, etc).

Allowed values:

  • none (None)
  • wrapper (Everything)
  • primary (Main graphic)

layout.max_width number

Maximum width. Leave blank to stretch to container width

Min: 50

layout.max_width_align string

Align.

Allowed values:

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

layout.layout_order string

Layout order.

Allowed values:

  • stack-default (Header – controls – legend – primary graphic – footer)
  • stack-2 (Primary graphic – header – controls – legend – footer)
  • stack-3 (Header – primary graphic – controls – legend – footer)
  • stack-4 (Controls – primary graphic – header – controls – legend – footer)
  • grid-1 (Grid mode: Primary graphic on the right)

layout.space_between_sections string

Space between sections.

Allowed values:

  • 0.5 (▁)
  • 1 (▃)
  • 1.5 (▄)
  • 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.read_direction string

Read direction. This will change the reading direction of the main text elements on the page. It's not possible to adjust this on all elements, such as axes. <br><br>Note that when direction is set to <b>right to left</b> any alignment icons will be reversed.

Allowed values:

  • ltr (Left to right)
  • rtl (Right to left)

layout.font_size_mobile_small number

layout.font_size_mobile_big number

layout.font_size_tablet number

layout.font_size_desktop number

layout.font_size_big_screen number

layout.breakpoint_mobile_small number

layout.breakpoint_mobile_big number

layout.breakpoint_tablet number

layout.breakpoint_desktop number

layout.breakpoint_big_screen number

layout.header_align string

Alignment.

Allowed values:

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

layout.title html

layout.title_styling boolean

Styling.

layout.title_font font

Title Font.

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 in <a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">rems</a>. The 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 html

layout.subtitle_styling boolean

Styling.

layout.subtitle_font font

Subtitle Font.

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 in <a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">rems</a>. The 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.header_text html

layout.header_text_styling boolean

Styling.

layout.header_text_size string

Size.

Allowed values:

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

layout.header_text_size_custom number

Custom. Specify a custom responsive font size in <a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">rems</a>. The best results will be with values between 1.2 and 3

layout.header_text_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.header_text_color color

Color.

layout.header_text_line_height number

Line height.

Max: 3

layout.header_text_space_above string

Space above.

Allowed values:

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

layout.header_text_space_above_custom number

Custom.

Max: 100

layout.header_border string

Allowed values:

  • top (Top)
  • bottom (Bottom)
  • top_and_bottom (Top & 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_border_space number

Space. Space between border and header text

layout.header_logo_enabled boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

layout.header_logo_src url

Image.

layout.header_logo_alt string

Alt text.

Link.

layout.header_logo_height number

Height.

layout.header_logo_align string

Align. Align logo inside either the header or the main visualization container

Allowed values:

  • inside (Header)
  • outside (Main container)

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

Alignment.

Allowed values:

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

layout.footer_text_size number

Size.

layout.footer_text_color color

Color.

layout.footer_styling boolean

Advanced footer styles.

layout.footer_font font

Font.

layout.footer_text_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

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 html

Note.

layout.footer_note_secondary html

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

layout.footer_logo_enabled boolean

Image.

Allowed values:

  • true (Enabled)
  • false (Disabled)

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 color is dark

layout.footer_logo_alt string

Alt text.

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)
  • top_and_bottom (Top & 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)

layout.footer_border_space number

Space. Space between border and footer text

Accessibility

layout.screenreader_text_primary text

Screenreader description. A text alternative to the visual content that will only be visible to <a href="https://help.flourish.studio/article/230-how-to-add-a-screenreader-description">screenreaders</a>, e.g. “The line chart shows China consistently higher than the other countries since 1990”. <br><br>Do not replicate your title, since that will also be read by screenreaders.

layout.screenreader_label string

Screenreader label. A short text label given to the main Flourish embed wrapper to provide an accessible name that is only visible to <a href="https://help.flourish.studio/article/230-how-to-add-a-screenreader-description">screenreaders</a>. Added in the form of an "aria-label".

layout.screenreader_hide_primary boolean

Screenreader mode for main visual container. Whether the main visual container is visible to <a href="https://help.flourish.studio/article/230-how-to-add-a-screenreader-description">screenreaders</a>. (Text in the header and footer are always available to screenreaders.)

Allowed values:

  • true (Hidden)
  • false (Readable)