Network graph
Updated 5 years ago to v6.0.1 by Flourish team
How to use this template
Network graph
A template that renders a network of points and links as a force-directed graph (AKA a “node-link diagram”).
Data requirements
The minimum data requirement is a two-column list of “Links”. Each row in the list specifies the points (displayed as circles) at either end of a link (displayed as a line). You can optionally include a third column that is used to set the width of the link. (This can be thought of as visual indicator of the strength or weight of a link.)
While the Links sheet is sufficient to create a network diagram, a second “Points” sheet allows for further flexibility. Rather than letting Flourish determine all the points to add to the network based on those listed in the Links sheet, the rows in the Points sheet define the complete collection of points. This sheet can also be used to assign groups (encoded using colour) and sizes to the points.
Tips
- Initially it is assumed that the network diagram is undirected. However, the “Network is directional” checkbox in the “Arrows” settings panel will turn each link into an arrow going from the “Source” point to the “Destination” point.
- The D3 force documentation may be useful for understanding the advanced settings.
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: @flourish/network-graph
version: 6
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: {
links: [
[ "LinksColumn1Value1", "LinksColumn2Value1",
[ "LinksColumn1Value2", "LinksColumn2Value2",
[ "LinksColumn1Value3", "LinksColumn2Value3",
...
],
nodes: [
[ "NodesColumn1Value1", "NodesColumn2Value1",
[ "NodesColumn1Value2", "NodesColumn2Value2",
[ "NodesColumn1Value3", "NodesColumn2Value3",
...
]
}
}
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/network-graph",
version: "6",
bindings: {
links: {
source: 0, // index of a column in your data
target: 1, // index of a column in your data
},
nodes: {
}
},
data: {
links: [
[ "LinksColumn1Value1", "LinksColumn2Value1",
[ "LinksColumn1Value2", "LinksColumn2Value2",
[ "LinksColumn1Value3", "LinksColumn2Value3",
...
],
nodes: [
[ "NodesColumn1Value1", "NodesColumn2Value1",
[ "NodesColumn1Value2", "NodesColumn2Value2",
[ "NodesColumn1Value3", "NodesColumn2Value3",
...
]
}
}
All possible bindings that you can supply are shown in this example:
{
template: "@flourish/network-graph",
version: "6",
bindings: {
links: {
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
},
nodes: {
id: 0, // index of a column in your data
group: 1, // index of a column in your data
size: 2, // index of a column in your data
image: 3, // index of a column in your data
metadata: [4, 5, ...], // index(es) of column(s) in your data
}
},
data: {
links: [
[ "LinksColumn1Value1", "LinksColumn2Value1",
[ "LinksColumn1Value2", "LinksColumn2Value2",
[ "LinksColumn1Value3", "LinksColumn2Value3",
...
],
nodes: [
[ "NodesColumn1Value1", "NodesColumn2Value1",
[ "NodesColumn1Value2", "NodesColumn2Value2",
[ "NodesColumn1Value3", "NodesColumn2Value3",
...
]
}
}
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:
{
links: [
{ "LinksHeader1": ..., "LinksHeader2": ..., ... },
{ "LinksHeader1": ..., "LinksHeader2": ..., ... },
{ "LinksHeader1": ..., "LinksHeader2": ..., ... },
...
],
nodes: [
{ "NodesHeader1": ..., "NodesHeader2": ..., ... },
{ "NodesHeader1": ..., "NodesHeader2": ..., ... },
{ "NodesHeader1": ..., "NodesHeader2": ..., ... },
...
]
}
... 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/network-graph",
version: "6",
bindings: {
links: {
source: "LinksHeader1",
target: "LinksHeader2",
},
nodes: {
}
},
data: {
links: [
{ "LinksHeader1": ..., "LinksHeader2": ..., ... },
{ "LinksHeader1": ..., "LinksHeader2": ..., ... },
{ "LinksHeader1": ..., "LinksHeader2": ..., ... },
...
],
nodes: [
{ "NodesHeader1": ..., "NodesHeader2": ..., ... },
{ "NodesHeader1": ..., "NodesHeader2": ..., ... },
{ "NodesHeader1": ..., "NodesHeader2": ..., ... },
...
]
}
}
All possible bindings that you can supply are shown in this example:
{
template: "@flourish/network-graph",
version: "6",
bindings: {
links: {
source: "LinksHeader1",
target: "LinksHeader2",
value: "LinksHeader3",
},
nodes: {
id: "NodesHeader1",
group: "NodesHeader2",
size: "NodesHeader3",
image: "NodesHeader4",
metadata: ["NodesHeader5", "NodesHeader6", ...],
}
},
data: {
links: [
{ "LinksHeader1": ..., "LinksHeader2": ..., ... },
{ "LinksHeader1": ..., "LinksHeader2": ..., ... },
{ "LinksHeader1": ..., "LinksHeader2": ..., ... },
...
],
nodes: [
{ "NodesHeader1": ..., "NodesHeader2": ..., ... },
{ "NodesHeader1": ..., "NodesHeader2": ..., ... },
{ "NodesHeader1": ..., "NodesHeader2": ..., ... },
...
]
}
}
(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/network-graph",
version: "6",
data: {
links: [
{
source: ...,
target: ...
},
...
],
nodes: [
{
metadata: [...]
},
...
]
},
...
}
And the full list of all possible properties is as follows:
{
template: "@flourish/network-graph",
version: "6",
data: {
links: [
{
source: ...,
target: ...,
value: ...
},
...
],
nodes: [
{
id: ...,
group: ...,
size: ...,
image: ...,
metadata: [...]
},
...
]
},
...
}
Meanings of the template data keys:
- links.source: source
- links.target: target
- links.value: A numerical value used to set the thickness of the links.
- nodes.id: A unique identifier for each point in the network. If not specified, point information will be extracted from the links sheet.
- nodes.group: A group to which the point belongs. If set, can be used to colour the points. Ignored if ID not set
- nodes.size: A numerical value used to size the points. Ignored if ID not set
- nodes.image: An image to go into the circle
- nodes.metadata: Specify additional columns to include in custom popup text (popup text must also be specified in settings panel). Ignored if ID not set
Template settings
Options for opts.state.
Points
constant_node_radius number
Radius.
min_node_radius number
Minimum radius. Any smaller circles will be scaled up to the specified level. (Ignored if greater than the “Maximum radius” setting.)
max_node_radius number
Maximum radius. Min: 1
node_scale_type string
Scale points relative to:. Allowed values:
max_node_value number
Value. Values bigger than this maximum will have a radius equal to the maximum radius
auto_scale boolean
Scale points down when not enough space. Allowed values:
max_fullness number
Max total point area. What percent of the space can the points fill before they are scaled down.
label_show string
Show. Allowed values:
label_size number
Size.
label_color_mode string
Color mode. Allowed values:
label_color color
Color.
image_opacity number
Opacity. Max: 1
fade_opacity number
Opacity of de-emphasized items. When a point is emphasized, how opaque the rest of the network should be Max: 1
Colour
color.scale_type string
Scale type. Allowed values:
color.categorical_type string
Allowed values:
- palette (Palette)
- generated (Generated)
color.categorical_palette colors
Palette.
color.categorical_extend boolean
Auto-extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once.
color.categorical_seed_color color
Seed color. Initial color in generated sequence (avoid shades of grey).
color.categorical_rotation_angle number
Hue rotation angle. Angle, in degrees, between one generated colour and the next. The default value, ~360/(Golden ratio), ensures adjacent hues are not too similar. Max: 360
color.categorical_color_space string
Allowed values:
- hcl (HCL)
- hsl (HSL)
color.categorical_custom_palette text
Custom overrides. Type the name of the entity whose colour you want to set, a colon and then a colour (using a name, hex-code or rgb declaration). Multiple colours can be set using multiple lines. For example:
Party 1: red
Party 2: #4455AA
Party 3: rgb(30,168,26)
color.sequential_palette string
Palette. Allowed values:
color.sequential_custom_min color
Minimum color.
color.sequential_custom_max color
Maximum color.
color.sequential_color_space string
Allowed values:
- rgb (RGB)
- lab (LAB)
- hcl (HCL)
- hsl (HSL)
color.sequential_reverse boolean
Reverse scale.
color.diverging_palette string
Palette. Allowed values:
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
Allowed values:
- rgb (RGB)
- lab (LAB)
- hcl (HCL)
- hsl (HSL)
color.diverging_reverse boolean
Reverse scale.
node_stroke_width number
Width. Max: 5
node_stroke_color color
Colour.
node_highlight_stroke_color color
Colour (highlighted).
Links
directional boolean
Show arrows on links.
constant_link_width number
Width.
min_link_width number
Minimum width. Any smaller links will be scaled up to the specified level. (Ignored if greater than the “Maximum width” setting.)
max_link_width number
Maximum width. Min: 1
link_scale_type string
Scale links relative to:. Allowed values:
max_link_value number
Value. Values bigger than this maximum will have a width equal to the maximum width
link_color color
Colour.
link_opacity number
Opacity. Max: 1
link_highlight_color color
Colour (highlighted).
link_highlight_opacity number
Opacity (highlighted). Max: 1
Popups
popup.show_popups boolean
Popups. Allowed values:
popup.is_custom boolean
Popup contents. Allowed values:
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:
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
popup_opacity number
Popup opacity on overlap. When the popup is overlapping other points and links, the opacity of the popup will change so most of the chart is still visible.
Legend
legend_position string
Legend position. Allowed values:
legend_interaction string
When clicking a legend item. Allowed values:
Animations
animate_simulation boolean
Animate network simulation. Display the initial animation of the network
simulation_speed number
Animation speed. Min: 1 Max: 10
Advanced
many_body_strength number
Repulsion between points. How strongly the points repulse each others. Known as “many-body force”. Measured in arbitrary units. Max: 50
collision_strength number
Collision-force strength. How strongly the points push away from each other when colliding. In arbitrary units. Max: 10
Number formatting
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:
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:
layout.background_image_enabled boolean
Image. Allowed values:
layout.background_color color
Color.
layout.background_image_src url
Image URL.
layout.background_image_size string
Size. Allowed values:
layout.background_image_position string
Position. Allowed values:
layout.layout_order string
Layout order. Allowed values:
layout.space_between_sections string
Space between sections. Allowed values:
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:
layout.border.top.color color
Color.
layout.border.right.width number
Right.
layout.border.right.style string
Style. Allowed values:
layout.border.right.color color
Color.
layout.border.bottom.width number
Bottom.
layout.border.bottom.style string
Style. Allowed values:
layout.border.bottom.color color
Color.
layout.border.left.width number
Left.
layout.border.left.style string
Style. Allowed values:
layout.border.left.color color
Color.
Header
layout.header_align string
Alignment. Allowed values:
layout.title string
layout.title_styling boolean
Styling.
layout.title_size string
Size. Allowed values:
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:
layout.title_color color
Color.
layout.title_line_height number
Line height. Max: 3
layout.title_space_above string
Space above. Allowed values:
layout.title_space_above_custom number
Custom. Max: 100
layout.subtitle string
layout.subtitle_styling boolean
Styling.
layout.subtitle_size string
Size. Allowed values:
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:
layout.subtitle_color color
Color.
layout.subtitle_line_height number
Line height. Max: 3
layout.subtitle_space_above string
Space above. Allowed values:
layout.subtitle_space_above_custom number
Custom. Max: 100
layout.text string
layout.text_styling boolean
Styling.
layout.text_size string
Size. Allowed values:
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:
layout.text_color color
Color.
layout.text_line_height number
Line height. Max: 3
layout.text_space_above string
Space above. Allowed values:
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:
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:
layout.header_logo_position_inside string
Position. Allowed values:
layout.header_logo_position_outside string
Position. Allowed values:
layout.header_logo_margin_top number
Top.
layout.header_logo_margin_right number
Right.
layout.header_logo_margin_bottom number
Bottom.
layout.header_logo_margin_left number
Left.
Footer
layout.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:
layout.footer_logo_enabled boolean
Allowed values:
- true (Enabled)
- false (Disabled)
layout.footer_logo_src url
Image.
layout.footer_logo_link_url string
Link.
layout.footer_logo_height number
Height.
layout.footer_logo_margin number
Margin.
layout.footer_logo_order string
Position. Allowed values:
layout.footer_align_vertical string
V. align. Allowed values:
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:
