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: "@flourish/parliament-chart",
    version: "3",
    bindings: {
        data: {
            party: 0, // 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: "@flourish/parliament-chart",
    version: "3",
    bindings: {
        data: {
            party: 0, // index of a column in your data
            seats: [1, 2, ...], // index(es) of column(s) 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: "@flourish/parliament-chart",
    version: "3",
    bindings: {
        data: {
            party: "DataHeader1",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/parliament-chart",
    version: "3",
    bindings: {
        data: {
            party: "DataHeader1",
            seats: ["DataHeader2", "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: "@flourish/parliament-chart",
    version: "3",
    data: {
    data: [
        {
            party: ...,
            seats: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/parliament-chart",
    version: "3",
    data: {
    data: [
        {
            party: ...,
            seats: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

• data.party: party
• data.seats: This should point to the column with election data

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

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.

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)

opacity number

Opacity.

unassigned_color color

Unassigned.

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.

show_seat_change string

This adds a new column that shows the change between 2 columns. "Auto" will compare the last 2 columns in your data "Custom" will allow you to handpick 2 columns to compare

seat_change_before string

Seat change before. Add the name of the column you want to compare with

seat_change_after string

Seat change after. Add the name of the column you want to compare with

seat_change_label string

Column name.

seat_format.prefix string

Prefix. Text to place in front of number

seat_format.suffix string

Suffix. Text to place after number

seat_format.n_dec number

Decimal places. Use negative integers to round to positive powers of ten (eg -2 rounds to the nearest 100)

seat_format.strip_zeros boolean

Remove trailing zeros.

seat_format.strip_separator boolean

Hide thousands separator below 10,000. Turn off if you want four-digit numbers to include a separator, e.g. “1,234” rather than “1234”.

seat_format.transform_labels boolean

Multiply/divide values.

seat_format.transform string

seat_format.multiply_divide_constant number

seat_format.exponentiate_constant number

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

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.

localization.output_separators string

Number format to display. How the numbers should appear on chart labels

Page

Layout

layout.body_font font

Font.

layout.max_width number

Maximum width. Leave blank to stretch to container width

layout.background_color color

Background.

layout.margin number

Margin.

layout.layout_order string

Layout order.

layout.space_between_sections string

Space between sections.

layout.space_between_sections_custom number

Custom.

Header

layout.header_align string

Alignment.

layout.title string

layout.title_styling boolean

Change title styles.

layout.title_size string

Size.

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.

layout.title_color color

Color.

layout.title_line_height number

Line height.

layout.subtitle string

layout.subtitle_styling boolean

Change subtitle styles.

layout.subtitle_size string

Size.

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.

layout.subtitle_color color

Color.

layout.subtitle_line_height number

Line height.

layout.subtitle_space_above string

Space above.

layout.subtitle_space_above_custom number

Custom.

layout.text string

layout.text_styling boolean

Change text styles.

layout.text_size string

Size.

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.

layout.text_color color

Color.

layout.text_line_height number

Line height.

layout.text_space_above string

Space above.

layout.text_space_above_custom number

Custom.

Footer

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.

layout.logo_url url

Image.

layout.logo_link_url string

Link.

layout.logo_height number

Height.

layout.logo_margin number

Margin.

layout.logo_order string

Position.

layout.footer_align_vertical string

V. align.