Network graph

Network graphs for visualising connections

Updated 6 months ago to v5.1.0 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.

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: 5

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:

    {
        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. 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/network-graph",
    version: "5",
    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: "5",
    bindings: {
        links: {
            source: "LinksHeader1",
            target: "LinksHeader2",
            value: "LinksHeader3"
        },
        nodes: {
            id: "NodesHeader1",
            group: "NodesHeader2",
            size: "NodesHeader3",
            metadata: ["NodesHeader4", "NodesHeader5", ...]
        }
    },
    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.)

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: "5",
data: {
    links: [
        {
            source: ...,
            target: ...
        },
        ...
    ],
    nodes: [
        {
            metadata: [...]
        },
        ...
    ]
},
...
}

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

{
template: "@flourish/network-graph",
version: "5",
data: {
    links: [
        {
            source: ...,
            target: ...,
            value: ...
        },
        ...
    ],
    nodes: [
        {
            id: ...,
            group: ...,
            size: ...,
            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.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.

General

background_color color

Background colour.

fade_opacity number

Opacity of de-emphasized items. When a point is emphasized, how opaque the rest of the network should be

Max: 1

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:

  • current (Maximum value in data)
  • arbitrary (Arbitrary maximum value)

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.

max_fullness number

Max total point area. What percent of the space can the points fill before they are scaled down.

Colour

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)

node_stroke_width number

Width.

Max: 5

node_stroke_color color

Colour.

node_highlight_stroke_color color

Colour (highlighted).

directional boolean

Show arrows on links.

Width.

Minimum width. Any smaller links will be scaled up to the specified level. (Ignored if greater than the “Maximum width” setting.)

Maximum width.

Min: 1

Scale links relative to:.

Allowed values:

  • current (Maximum value in data)
  • arbitrary (Arbitrary maximum value)

Value. Values bigger than this maximum will have a width equal to the maximum width

Colour.

Opacity.

Max: 1

Colour (highlighted).

Opacity (highlighted).

Max: 1

Popups

show_popup boolean

Show popup on points.

custom_popup boolean

Use custom text in popups.

custom_popup_text text

Custom popup text. Use HTML markup, plus column names inside {{brackets}}, to include data

Text.

Outline.

Make popups transparent.

Allowed values:

  • always (Always)
  • both (When overlapping points or links)
  • nodes (When overlapping points)
  • never (Never)

Opacity.

Min: 0.1

Max: 1

Legend

legend_position string

Legend position.

Allowed values:

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

legend_interaction string

When clicking a legend item.

Allowed values:

  • filter_and_layout (Hide/show groups and update layout)
  • filter_in_position (Hide/show groups in current layout)
  • none (Nothing)

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:

  • ,. (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 color

Background.

layout.margin number

Margin.

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

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

Change title styles.

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

layout.subtitle_styling boolean

Change subtitle styles.

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

Change text styles.

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

Note.

layout.size number

Size.

layout.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.logo_url url

Image.

Link.

layout.logo_height number

Height.

layout.logo_margin number

Margin.

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