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: _210
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: { 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: "_210", version: "_10", 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: "_210", version: "_10", 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 } }, 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: "_210", version: "_10", 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: "_210", version: "_10", bindings: { links: { source: "LinksHeader1", target: "LinksHeader2", value: "LinksHeader3", }, nodes: { id: "NodesHeader1", group: "NodesHeader2", size: "NodesHeader3", } }, 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: "_210", version: "_10", data: { links: [ { source: ..., target: ... }, ... ] }, ... }
And the full list of all possible properties is as follows:
{ template: "_210", version: "_10", data: { links: [ { source: ..., target: ..., value: ... }, ... ], nodes: [ { id: ..., group: ..., size: ... }, ... ] }, ... }
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, node 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
Template settings
Options for opts.state
.
Title and subtitle
title string
Title.
subtitle string
Subitle.
title_text_color color
Text colour.
title_padding number
Margin below.
General
background_color color
Background colour.
fade_opacity number
Opacity of de-emphasized items. Max: 1
legend_show boolean
Show legend.
Points
node_size number
Default size. Only used if point size not set in data
palette string
Colour scheme. Allowed values:
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.
link_weight number
Link weight multiplier. Control the thickness of the links
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 boolean
Show popup on points.
popup text
Text in popup. Use HTML markup, plus {{ brackets }} to include data
popup_text_color color
Text.
popup_box_color color
Outline.
popup_opacity number
Opacity. Min: 0.1 Max: 1
Forces
manybodyforce_strength number
Many-body-force strength. Arbitrary units Max: 50