Network graph

Network graphs for visualising connections

Updated 2 years ago by Template retirement home

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

version: _41

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

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

{
template: "_251",
version: "_41",
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.

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

palette_type string

Palette type.

Allowed values:

  • predefined (Use a predefined palette)
  • custom (Use a custom palette)

predefined_palette string

Palette.

Allowed values:

  • flourish_default_1 (Flourish categories A)
  • flourish_default_2 (Flourish categories B)
  • carto_pastel (Pastel light)
  • carto_antique (Pastel dark)
  • carto_rainbow (Rainbow)
  • schemeCategory10 (Category 10)
  • schemeAccent (Accent)
  • schemeDark2 (Dark 2)
  • schemePastel1 (Pastel 1)
  • schemePastel2 (Pastel 2)

custom_palette text

Custom palette. Enter a set of colours, one per line. Valid colour formats include named colours (eg red or forestgreen), hex codes (eg #34ff34 or #cdc) and RGB codes (eg rgb(28,28,28) or rgba(200,175,150,0.5)). Invalid colours will be ignored.

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_show boolean

Show legend.

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