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

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

{
    template: "@flourish/heatmap",
    version: "1",
    bindings: {
        data: {
            x: 0, // index of a column in your data
            y: 1, // index of a column in your data
            value: 2, // index of a column in your data
            filter: 3, // 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: "@flourish/heatmap",
    version: "1",
    bindings: {
        data: {
            
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/heatmap",
    version: "1",
    bindings: {
        data: {
            x: "DataHeader1",
            y: "DataHeader2",
            value: "DataHeader3",
            filter: "DataHeader4",
        }
    },
    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/heatmap",
    version: "1",
    data: {},
    ...
}

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

{
    template: "@flourish/heatmap",
    version: "1",
    data: {
    data: [
        {
            x: ...,
            y: ...,
            value: ...,
            filter: ...
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

• data.x: x
• data.y: y
• data.value: value
• data.filter: filter

Template settings

Options for opts.state.

Heatmap

x_axis_datatype string

Data type.

x_axis_binning string

Binning mode.

x_axis_bin_width number

Bin width. The numeric range of each bin – e.g. a bin width of 10 would give bins of 0–10, 10–20, etc (assuming a bin center of 5).

x_axis_bin_center number

Bin center. One value you'd like as the center of a bin – e.g. with a bin width of 10, a center of 5 would give 0–10, 10–20, 20–30, etc, while a center of 0 would give -5–5, 5–10, 10–20, etc.

cell_x_margin number

Cell padding.

y_axis_datatype string

Data type.

y_axis_binning string

Binning mode.

y_axis_bin_width number

Bin width. The numeric range of each bin – e.g. a bin width of 10 would give bins of 0–10, 10–20, etc (assuming a bin center of 5).

y_axis_bin_center number

Bin center. One value you'd like as the center of a bin – e.g. with a bin width of 10, a center of 5 would give 0–10, 10–20, 20–30, etc, while a center of 0 would give -5–5, 5–10, 10–20, etc.

cell_y_margin number

Cell padding.

height_mode string

Height mode. Apsect ratio and fixed modes only work when embedding responsively with a script embed

cell_height number

Height. Height of each cell in rems (multiple of base font size)

cell_aspect number

Aspect. Aspect ratio (width/height) of each cell

Colours

color.scale_type string

Scale type.

color.categorical_type string

color.categorical_palette colors

Palette.

color.categorical_extend boolean

Extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once.

color.categorical_seed_color color

Seed color. Initial color in generated sequence (avoid shades of grey).

color.categorical_rotation_angle number

Hue rotation angle. Angle, in degrees, between one generated colour and the next. The default value, ~360/(Golden ratio), ensures adjacent hues are not too similar.

color.categorical_color_space string

color.categorical_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:

---

Party 1: red
Party 2: #4455AA
Party 3: rgb(30,168,26)

color.sequential_palette string

Palette.

color.sequential_custom_min color

Minimum color.

color.sequential_custom_max color

Maximum color.

color.sequential_color_space string

color.sequential_reverse boolean

Reverse.

color.diverging_palette string

Palette.

color.diverging_custom_min color

Minimum color.

color.diverging_custom_mid color

Midpoint color.

color.diverging_custom_max color

Maximum color.

color.diverging_color_space string

color.diverging_reverse boolean

Reverse.

color.binning boolean

Sequential mode. In linear mode, the color scale will run as a smooth gradient between 2 colors. In binned mode, the gradient will be divided in smaller blocks.

color.bin_count number

Number of bins.

color.bin_mode string

Binning mode.

color.bin_thresholds string

Custom thresholds. Write your custom thresholds, separated by a ";" For example 5;10;15

Legend

legend.show_legend boolean

legend.text_color color

Color.

legend.text_size number

Size.

legend.title string

Title.

legend.title_weight string

Weight.

legend.color_band_width number

Width.

legend.color_band_height number

Height.

legend.color_band_radius number

Roundness. The radius of the corners of the color band (in pixels)

legend.binned_label_mode string

Binned label mode.

legend.binned_label_custom string

Custom bin labels. List numeric values, separated by semi-colons.

legend_categorical.show_legend boolean

legend_categorical.text_color color

Color.

legend_categorical.text_size number

Size.

legend_categorical.title string

Title.

legend_categorical.title_weight string

Weight.

legend_categorical.swatch_width number

Width.

legend_categorical.swatch_height number

Height.

legend_categorical.swatch_radius number

Roundness. The radius of the corners of the swatch (in pixels)

legend_categorical.order_override text

Custom order override. Manually specify the order of legend entries (one entry per line)

legend_categorical.orientation string

Orientation.

X axis

x.axis_position string

Position.

x.y_axis_position string

Y value. Vertical position of the x axis on the y scale

x.numeric_scale_type string

Type.

x.linear_min number

Min.

x.linear_max number

Max.

x.log_min number

Min.

x.log_max number

Max.

x.datetime_min string

Min (date).

x.datetime_max string

Max (date).

x.title_mode string

Type.

x.title string

Text.

x.title_styling boolean

Styling.

x.title_weight string

Weight.

x.title_color color

Color.

x.title_size number

Size.

x.title_padding number

Padding.

x.tick_label_position string

Position.

x.tick_label_styling boolean

Styling.

x.tick_label_size number

Size.

x.tick_label_color color

Color.

x.tick_padding number

Padding.

x.tick_label_angle string

Angle.

x.tick_label_weight string

Weight.

x.tick_label_space_mode string

Space mode.

x.tick_label_space number

Space.

x.tick_mode string

Mode.

x.tick_number number

Number. Approximate number of ticks or gridlines. The actual number will depend on the range of values, chart size, etc.

x.tick_custom text

One tick label per line. Specify the ticks to show, one per line

x.line_and_tick_color color

Line color.

x.line_and_tick_width number

Line width.

x.tick_length number

Tick length.

x.tick_side string

Tick side.

x.line_visible boolean

Axis line.

x.edge_padding number

Edge padding (%). Space between start/end of axis line and first/last category tick as a percentage of the spacing between ticks

x.gridlines_visible boolean

x.gridlines_styling boolean

Styling.

x.gridline_color color

Color.

x.gridline_style string

Style.

x.gridline_width number

Width.

x.gridline_category_dividers boolean

Put lines between categories. On a categorical axis this option disables the gridline on each tick and instead adds rules between each category to give a table-like design. Ignored for date and numeric axes.

x.gridline_category_dividers_extend boolean

Extend. Extends the dividers into the axis margins.

Y axis

y.axis_visible boolean

y.numeric_scale_type string

Type.

y.linear_min number

Min.

y.linear_max number

Max.

y.log_min number

Min.

y.log_max number

Max.

y.datetime_min string

Min (date).

y.datetime_max string

Max (date).

y.title_mode string

Type.

y.title string

Text.

y.title_styling boolean

Styling.

y.title_weight string

Weight.

y.title_color color

Color.

y.title_size number

Size.

y.title_padding number

Padding.

y.tick_label_position string

Position.

y.tick_label_styling boolean

Styling.

y.tick_label_size number

Size.

y.tick_label_color color

Color.

y.tick_padding number

Padding.

y.tick_label_angle string

Angle.

y.tick_label_weight string

Weight.

y.tick_label_space_mode string

Space mode.

y.tick_label_space number

Space.

y.tick_mode string

Mode.

y.tick_number number

Number. Approximate number of ticks or gridlines. The actual number will depend on the range of values, chart size, etc.

y.tick_custom text

One tick label per line. Specify the ticks to show, one per line

y.line_and_tick_color color

Line color.

y.line_and_tick_width number

Line width.

y.tick_length number

Tick length.

y.tick_side string

Side.

y.line_visible boolean

Axis line.

y.edge_padding number

Edge padding (%). Space between start/end of axis line and first/last category tick as a percentage of the spacing between ticks

y.gridlines_visible boolean

y.gridlines_styling boolean

Styling.

y.gridline_color color

Color.

y.gridline_style string

Style.

y.gridline_width number

Width.

y.gridline_category_dividers boolean

Put lines between categories. On a categorical axis this option disables the gridline on each tick and instead adds rules between each category to give a table-like design. Ignored for date and numeric axes.

y.gridline_category_dividers_extend boolean

Extend. Extends the dividers into the axis margins

Animation

animation_style string

animation_duration number

Animation duration. The duration it takes each cell to transition, in seconds

animation_spread number

Animation spread. The number of seconds over which the cell animations begin. Leave blank for a special spread that depends on the number of cells.

animation_key boolean

Only animate cells with same x and y value.

Controls

row_filter_all boolean

Include “All”.

row_filter_all_text string

“All” text.

row_filter.control_type string

Control type. Choose between a dropdown, buttons or a time slider.

row_filter.control_styles boolean

Adv..

row_filter.button_group boolean

Grouped.

row_filter.button_group_width_mode string

Button group width.

row_filter.button_group_width_fixed number

Width.

row_filter.dropdown_width_mode string

Dropdown width.

row_filter.dropdown_width_fixed number

Width.

row_filter.slider_background_color color

Background.

row_filter.slider_font_color color

Text.

row_filter.slider_handle_color color

Handle.

row_filter.slider_width number

Width.

row_filter.slider_margin number

Label width.

row_filter.slider_handle_height number

Height.

row_filter.slider_track_height number

Track height.

row_filter.slider_play_button boolean

Play button.

row_filter.slider_loop boolean

Loop.

row_filter.slider_step_time number

Time between steps. Measured in seconds, positive values move the slider left to right, negative values move the slider right to left.

row_filter.slider_restart_pause number

Pause before loop. Measured in seconds and in addition to the regular step time displayed above.

row_filter.sort string

Sorting.

row_filter.sort_temporal_format string

Date/time format in data. The date/time format in your data sheet. Used only to sort the data, if required. If your format isn’t in the list, you can enter a custom format using d3-time-format syntax. See npmjs.com/package/d3-time-format for details.

controls_style.font_size number

Text size.

controls_style.font_weight string

Text weight.

controls_style.padding number

Height. Space below and above controls text

dropdown_style.background color

Background.

dropdown_style.font_color color

Text color.

dropdown_style.border_styles_advanced boolean

Dropdown border styles.

dropdown_style.border_style string

Border style. Show border on all sides, or only at the bottom

dropdown_style.border_width number

Border width.

dropdown_style.border_color color

Color.

dropdown_style.border_transparency number

Transparency.

dropdown_style.border_radius number

Radius.

button_style.background color

Background.

button_style.background_selected color

Selected.

button_style.background_hover color

Mouse over.

button_style.font_color color

Text color.

button_style.font_color_selected color

Selected.

button_style.font_color_hover color

Mouse over.

button_style.button_styles_advanced boolean

Button border styles.

button_style.border_width number

Border width.

button_style.border_color color

Color.

button_style.border_transparency number

Transparency.

button_style.border_radius number

Radius.

Popups

popup.show_popups boolean

Popups.

popup.is_custom boolean

Popup contents.

popup.custom_template text

Popup content. The text to appear in the popup. You can use {{column_name}} to add a value from your data. It must be in a selected column, but you can add columns to “Metadata” if you just want to include them for use in the popup. Advanced users can include HTML to apply layouts, formatting, images, etc.

popup.show_pointer boolean

Pointer.

popup.show_shadow boolean

Shadow.

popup.style_popups boolean

Custom styling.

popup.text_color color

Text colour.

popup.align string

Alignment.

popup.font_size number

Font size.

popup.fill_color color

Fill colour.

popup.opacity number

Fill opacity.

popup.padding number

Padding.

popup.border_radius number

Radius. Corner radius of popup

Number formatting

formatter.prefix string

Prefix. Text to place in front of number

formatter.suffix string

Suffix. Text to place after number

formatter.n_dec number

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

formatter.advanced boolean

Advanced.

formatter.negative_sign string

Styling of negative numbers.

formatter.strip_zeros boolean

Remove trailing zeros.

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

formatter.transform_labels boolean

Multiply/divide values.

formatter.transform string

formatter.multiply_divide_constant number

formatter.exponentiate_constant number

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

Layout

Layout

layout.body_font font

Main font. This font will apply to the whole graphic by default, but you can optionally change the font for the title, subtitle, footer, etc in the Header and Footer settings panels.

layout.font_color color

Text color. This color will apply to the whole graphic by default, but you can optionally change the color for individual text elements, in other settings panels.

layout.background_color_enabled boolean

Color.

layout.background_image_enabled boolean

Image.

layout.background_color color

Background color.

layout.background_image_src url

Image URL.

layout.background_image_size string

Size.

layout.background_image_position string

Position.

layout.max_width_target string

Maximum width. Apply a maximum width to just the main graphic or everything (main graphic plus header, footer, etc)

layout.max_width number

Maximum width. Leave blank to stretch to container width

layout.max_width_align string

Align.

layout.layout_order string

Layout order.

layout.space_between_sections string

Space between sections.

layout.space_between_sections_custom number

Custom.

layout.margin_top number

Top.

layout.margin_right number

Right.

layout.margin_bottom number

Bottom.

layout.margin_left number

Left.

layout.border.enabled boolean

Show borders around visualisation.

layout.border.top.width number

Top.

layout.border.top.style string

Style.

layout.border.top.color color

Color.

layout.border.right.width number

Right.

layout.border.right.style string

Style.

layout.border.right.color color

Color.

layout.border.bottom.width number

Bottom.

layout.border.bottom.style string

Style.

layout.border.bottom.color color

Color.

layout.border.left.width number

Left.

layout.border.left.style string

Style.

layout.border.left.color color

Color.

Header

layout.header_align string

Alignment.

layout.title string

layout.title_styling boolean

Change title styles.

layout.title_font font

Title Font.

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

Space above.

layout.title_space_above_custom number

Custom.

layout.subtitle string

layout.subtitle_styling boolean

Change subtitle styles.

layout.subtitle_font font

Subtitle Font.

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

layout.header_text_styling boolean

Styling.

layout.header_text_size string

Size.

layout.header_text_size_custom number

Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3

layout.header_text_weight string

Weight.

layout.header_text_color color

Color.

layout.header_text_line_height number

Line height.

layout.header_text_space_above string

Space above.

layout.header_text_space_above_custom number

Custom.

layout.header_border string

layout.header_border_width number

Width.

layout.header_border_color color

Color.

layout.header_border_style string

Style.

layout.header_border_space number

Space. Space between border and header text

layout.header_logo_enabled boolean

layout.header_logo_src url

URL.

layout.header_logo_height number

Height.

layout.header_logo_align string

Align. Align logo inside header or outer visualisation container

layout.header_logo_position_inside string

Position.

layout.header_logo_position_outside string

Position.

layout.header_logo_margin_top number

Top.

layout.header_logo_margin_right number

Right.

layout.header_logo_margin_bottom number

Bottom.

layout.header_logo_margin_left number

Left.

Footer

layout.footer_align string

Alignment.

layout.footer_text_size number

Size.

layout.footer_text_color color

Color.

layout.footer_styling boolean

Advanced footer styles.

layout.footer_font font

Font.

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

Note.

layout.footer_note_secondary string

Note (secondary). The secondary note is placed below the source and primary note

layout.footer_logo_enabled boolean

Image.

layout.footer_logo_src url

Image.

layout.footer_logo_src_light hidden

Image (light version). If provided this version will be used whenever the background colour is dark

layout.footer_logo_link_url string

Link.

layout.footer_logo_height number

Height.

layout.footer_logo_margin number

Margin.

layout.footer_logo_order string

Position.

layout.footer_align_vertical string

V. align.

layout.footer_border string

layout.footer_border_width number

Width.

layout.footer_border_color color

Color.

layout.footer_border_style string

Style.

layout.footer_border_space number

Space. Space between border and footer text