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: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

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: "_647",
    version: "_5",
    bindings: {
        data: {
            party: 0, // index of a column in your data
            seats_current: 1, // index of a column in your data
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

All possible bindings that you can supply are shown in this example:

{
    template: "_647",
    version: "_5",
    bindings: {
        data: {
            party: 0, // index of a column in your data
            seats_current: 1, // index of a column in your data
            seats_previous: 2, // index of a column in your data
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

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:

{
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }

... 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: "_647",
    version: "_5",
    bindings: {
        data: {
            party: "DataHeader1",
            seats_current: "DataHeader2",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

All possible bindings that you can supply are shown in this example:

{
    template: "_647",
    version: "_5",
    bindings: {
        data: {
            party: "DataHeader1",
            seats_current: "DataHeader2",
            seats_previous: "DataHeader3",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

(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: "_647",
    version: "_5",
    data: {
    data: [
        {
            party: ...,
            seats_current: ...
        },
        ...
    ]
},
    ...
}

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

{
    template: "_647",
    version: "_5",
    data: {
    data: [
        {
            party: ...,
            seats_current: ...,
            seats_previous: ...
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

• data.party: party
• data.seats_current: This should point to the column with the most recent election data
• data.seats_previous: This data is used to compare the most recent election results to a previous one

Template settings

Options for opts.state.

Parliament layout

num_of_seats number

Number of seats.

hemicycle_arc number

Size of arc.

circle_inner number

Inner space.

manual_row_count boolean

Number of rows.

num_of_rows number

Rows.

Colours

palette string

Automatic colour scheme.

custom_palette text

Custom party colours. Specify one per line with a party name and colour code or name, in the form “Republicans: #37363”

opacity number

Opacity.

unassigned_color color

Unassigned.

bg_color color

Background.

Buttons

use_buttons boolean

Allow user to switch to earlier election result.

margin_button number

Margin.

Legend

show_legend boolean

Show legend.

use_hover_animation boolean

Filter dots when hovering over legend. If unchecked then there will no longer be a hover animation

legend_align string

Align legend.

Table

show_table boolean

Show table.

gain_color color

Gain color.

loss_color color

Loss color.

default_text_color color

Default color.

header_weight string

Header text.

margin_table number

Margin.

Header

header.title string

Title.

header.subtitle string

Subtitle.

header.color color

Color.

header.align string

Alignment.

header.margin number

Margin.

header.margin_advanced boolean

Advanced margin settings.

header.margin_top number

Top.

header.margin_right number

Right.

header.margin_bottom number

Bottom.

header.margin_left number

Left.

Footer

footer.source_name string

Source name.

footer.source_url string

Source url.

footer.multiple_sources boolean

Multiple sources.

footer.source_name_2 string

Source name.

footer.source_url_2 string

Source url.

footer.source_name_3 string

Source name.

footer.source_url_3 string

Source url.

footer.source_label string

Source label.

footer.note string

Note.

footer.size number

Size.

footer.color color

Color.

footer.align string

Alignment.

footer.margin number

Overall.

footer.margin_top number

Top.

footer.margin_right number

Right.

footer.margin_bottom number

Bottom.

footer.margin_left number

Left.

footer.margin_advanced boolean

Advanced.

Animations

animation_duration number

Animation duration. How long the seats take to "flip" when changing party, in seconds

animation_stagger number

Animation spread. How many seconds to spread the seat animations across

animate_on_load boolean

Animate on load. Whether to animate the seats when the visualisations first loads