This section documents API usage specific to this template, so for an introduction we suggest you refer to the generic API documentation instead.

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: "_251",
    version: "_41",
    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: "_251",
    version: "_41",
    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
            metadata: [3, 4, ...], // 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: "_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.)

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: "_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

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.

node_scale_type string

Scale points relative to:.

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.

predefined_palette string

Palette.

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.

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.

link_scale_type string

Scale links relative to:.

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.

link_highlight_color color

Colour (highlighted).

link_highlight_opacity number

Opacity (highlighted).

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

popup_text_color color

Text.

popup_box_color color

Outline.

popup_opacity_mode string

Make popups transparent.

popup_opacity number

Opacity.

Legend

legend_show boolean

Show legend.

legend_interaction string

When clicking a legend item.

Animations

animate_simulation boolean

Animate network simulation. Display the initial animation of the network

simulation_speed number

Animation speed.

Advanced

many_body_strength number

Repulsion between points. How strongly the points repulse each others. Known as “many-body force”. Measured in arbitrary units.

collision_strength number

Collision-force strength. How strongly the points push away from each other when colliding. In arbitrary units.