Chord diagram
Updated 6 years ago by Template retirement home
How to use this template
This template is useful for showing relationships and the flow to and from values. It gives the option to color the chords as linear gradients or have the chords filled based on the source (the from column).
Data requirements
There must be three columns. The first specifies the values from, the second specifies the values to, and the third is the count (a numerical number describing how many flows there were).
Tips
You can change the color based on your needs. By default it is a gradient but you can also use a fill colour. The fill colour is based on the biggest value.
If your text label is overlapping and your label alignment is "Along Arcs" your overlapping text label will not show up. This might be convenient for you, but you can also flip the label 90° that way your label won't overlap and will show up.
Chord diagrams can be difficult to understand so make sure to add an appropriate title. You can also add a popup to make it easier for the user to understand.
Flourish allows you to export an SVG. Do this if you want to add annotations in your favourite vector editing program.
Credits
Created by the Flourish team. Sample data from Crazy for Friends. Want to see additional features? Let us know at support@flourish.studio.
API information
This section documents API usage specific to this template, so for an introduction we suggest you refer to the generic API documentation instead.
template: _661
version: _9
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: { connections: [ [ "ConnectionsColumn1Value1", "ConnectionsColumn2Value1", [ "ConnectionsColumn1Value2", "ConnectionsColumn2Value2", [ "ConnectionsColumn1Value3", "ConnectionsColumn2Value3", ... ] } }
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: "_661", version: "_9", bindings: { connections: { from: 0, // index of a column in your data to: 1, // index of a column in your data value: 2, // index of a column in your data } }, data: { connections: [ [ "ConnectionsColumn1Value1", "ConnectionsColumn2Value1", [ "ConnectionsColumn1Value2", "ConnectionsColumn2Value2", [ "ConnectionsColumn1Value3", "ConnectionsColumn2Value3", ... ] } }
All possible bindings that you can supply are shown in this example:
{ template: "_661", version: "_9", bindings: { connections: { from: 0, // index of a column in your data to: 1, // index of a column in your data value: 2, // index of a column in your data } }, data: { connections: [ [ "ConnectionsColumn1Value1", "ConnectionsColumn2Value1", [ "ConnectionsColumn1Value2", "ConnectionsColumn2Value2", [ "ConnectionsColumn1Value3", "ConnectionsColumn2Value3", ... ] } }
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:
{ connections: [ { "ConnectionsHeader1": ..., "ConnectionsHeader2": ..., ... }, { "ConnectionsHeader1": ..., "ConnectionsHeader2": ..., ... }, { "ConnectionsHeader1": ..., "ConnectionsHeader2": ..., ... }, ... ] }
... 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: "_661", version: "_9", bindings: { connections: { from: "ConnectionsHeader1", to: "ConnectionsHeader2", value: "ConnectionsHeader3", } }, data: { connections: [ { "ConnectionsHeader1": ..., "ConnectionsHeader2": ..., ... }, { "ConnectionsHeader1": ..., "ConnectionsHeader2": ..., ... }, { "ConnectionsHeader1": ..., "ConnectionsHeader2": ..., ... }, ... ] } }
All possible bindings that you can supply are shown in this example:
{ template: "_661", version: "_9", bindings: { connections: { from: "ConnectionsHeader1", to: "ConnectionsHeader2", value: "ConnectionsHeader3", } }, data: { connections: [ { "ConnectionsHeader1": ..., "ConnectionsHeader2": ..., ... }, { "ConnectionsHeader1": ..., "ConnectionsHeader2": ..., ... }, { "ConnectionsHeader1": ..., "ConnectionsHeader2": ..., ... }, ... ] } }
(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: "_661", version: "_9", data: { connections: [ { from: ..., to: ..., value: ... }, ... ] }, ... }
And the full list of all possible properties is as follows:
{ template: "_661", version: "_9", data: { connections: [ { from: ..., to: ..., value: ... }, ... ] }, ... }
Meanings of the template data keys:
- connections.from: from
- connections.to: to
- connections.value: value
Template settings
Options for opts.state
.
Color
palette string
Palette. Allowed values:
gradient_type string
Chord colour mode. Allowed values:
custom_palette text
Custom palette. Write a colour value (name, rgb or hex-code) for each arc name. Separated by a colon. For example: <br /> <hr /> Chandler: #333333<br /> Joey: red
background_color color
Background color.
Chords
opacity_chord number
Chord Opacity. Max: 1
selected_chords text
Highlight chords. To highlight an chords ribbons, write the name of each arc on a line. You can also create a story and highlight/unhighlight by clicking.
use_mouseover_label boolean
Show chord values on hover.
use_mouseover_chords boolean
Highlight chord on mouseover.
chord_labels_reponsive boolean
Label text size. Auto changed the label size based on the window size, subject to the specified min and max Allowed values:
chord_label_font_size number
Text size. Max: 40
chord_label_font_size_min number
Min size. Max: 40
chord_label_font_size_max number
Max size. Max: 40
show_chord_stroke boolean
Allowed values:
- true (Enabled)
- false (Disabled)
chord_stroke_color color
Stroke color.
chord_stroke_opacity number
Stroke opacity. Max: 1
Arcs
arc_spacing number
Space below arcs. in pixels
pad_angle number
Space between arcs. in radians Max: 1
use_mouseover_arcs boolean
Highlight chords on hover.
label_alignment string
Alignment. Allowed values:
label_responsive boolean
Label text size. Auto changed the label size based on the window size, subject to the specified min and max Allowed values:
label_font_size number
Text size. Max: 40
label_font_size_min number
Min size. Max: 40
label_font_size_max number
Max size. Max: 40
label_color color
Arc label color.
use_label_color_arc boolean
Make the arc label color the same as the arc color.
Popup
popup_type string
Popup. Allowed values:
popup_content text
Popup Description. Add a title or a discription to help explain your tooltip
Header
header.title string
Title.
header.subtitle string
Subtitle.
header.color color
Color.
header.align string
Alignment. Allowed values:
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.
Footer
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:
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.
Animation
animation_speed number
Animation Duration.