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",
            ...
        ],
        geo: [
            [ "GeoColumn1Value1", "GeoColumn2Value1",
            [ "GeoColumn1Value2", "GeoColumn2Value2",
            [ "GeoColumn1Value3", "GeoColumn2Value3",
            ...
        ]
    }
}

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/data-explorer",
    version: "1",
    bindings: {
        data: {
            
        },
        geo: {
            
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ],
        geo: [
            [ "GeoColumn1Value1", "GeoColumn2Value1",
            [ "GeoColumn1Value2", "GeoColumn2Value2",
            [ "GeoColumn1Value3", "GeoColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@flourish/data-explorer",
    version: "1",
    bindings: {
        data: {
            categoryColumns: [0, 1, ...], // index(es) of column(s) in your data
            numericColumns: [2, 3, ...], // index(es) of column(s) in your data
            filter: 4, // index of a column in your data
            id: 5, // index of a column in your data
            label: 6, // index of a column in your data
            geo_key: 7, // index of a column in your data
            metadata: [8, 9, ...], // index(es) of column(s) in your data
        },
        geo: {
            geo_key: 0, // index of a column in your data
            feature: 1, // index of a column in your data
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ],
        geo: [
            [ "GeoColumn1Value1", "GeoColumn2Value1",
            [ "GeoColumn1Value2", "GeoColumn2Value2",
            [ "GeoColumn1Value3", "GeoColumn2Value3",
            ...
        ]
    }
}

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": ..., ... },
            ...
        ],
        geo: [
            { "GeoHeader1": ..., "GeoHeader2": ..., ... },
            { "GeoHeader1": ..., "GeoHeader2": ..., ... },
            { "GeoHeader1": ..., "GeoHeader2": ..., ... },
            ...
        ]
    }

... 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/data-explorer",
    version: "1",
    bindings: {
        data: {
            
        },
        geo: {
            
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ],
        geo: [
            { "GeoHeader1": ..., "GeoHeader2": ..., ... },
            { "GeoHeader1": ..., "GeoHeader2": ..., ... },
            { "GeoHeader1": ..., "GeoHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/data-explorer",
    version: "1",
    bindings: {
        data: {
            categoryColumns: ["DataHeader1", "DataHeader2", ...],
            numericColumns: ["DataHeader3", "DataHeader4", ...],
            filter: "DataHeader5",
            id: "DataHeader6",
            label: "DataHeader7",
            geo_key: "DataHeader8",
            metadata: ["DataHeader9", "DataHeader10", ...],
        },
        geo: {
            geo_key: "GeoHeader1",
            feature: "GeoHeader2",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ],
        geo: [
            { "GeoHeader1": ..., "GeoHeader2": ..., ... },
            { "GeoHeader1": ..., "GeoHeader2": ..., ... },
            { "GeoHeader1": ..., "GeoHeader2": ..., ... },
            ...
        ]
    }
}

(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/data-explorer",
    version: "1",
    data: {
    data: [
        {
            categoryColumns: [...],
            numericColumns: [...],
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/data-explorer",
    version: "1",
    data: {
    data: [
        {
            categoryColumns: [...],
            numericColumns: [...],
            filter: ...,
            id: ...,
            label: ...,
            geo_key: ...,
            metadata: [...]
        },
        ...
    ],
    geo: [
        {
            geo_key: ...,
            feature: ...
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

• data.categoryColumns: Columns containing categorical data
• data.numericColumns: Columns containing numeric data
• data.filter: Categorical column to filter by
• data.id: Column to use as a unique id (to ensure object constancy during transitions)
• data.label: Column to use as a label for each item
• data.geo_key: Unique id for joining boundary data. Must contain values that match "Geo key" values in "Boundaries". Leave blank to disable map mode.
• data.metadata: Makes additional columns (text, emoji, image URLs, etc) available in custom popups
• geo.geo_key: Unique id for joining boundary data. Most contain ids that match the "Geo key" values in "Data".
• geo.feature: A geoJSON feature describing a boundary (typically geometry type will be Polygon)

Template settings

Options for opts.state.

Data Explorer

transition_duration number

Transition duration.

scatter_max_radius number

Scatter plot maximum radius.

aspect_ratio number

Chart aspect ratio.

filter_out_blank_values boolean

Hide items with invalid or missing values. Filter out items with invalid or missing values. For example if Position by is a categorical column, items without a valid value will be filtered out.

show_all_geojson_features boolean

Show all GeoJSON features. Show all GeoJSON features even if not joined to a row in the Data sheet

prevent_clipping boolean

Prevent clipping. Prevent shapes close to the chart boundaries being clipped. (This particularly applies to beeswarm and scatter layouts.)

Group Labels

group_label_size number

Size. Sets label size for 1-d groups (see also X axis and Y axis)

group_label_color color

Colour.

group_label_weight string

Weight.

Color

default_color color

Default color. Color to use when 'Shade by' is 'None'

invalid_color color

Missing or invalid data color. Color to use when data value is invalid or missing

stroke_color color

Stroke color.

stroke_width number

Stroke width.

color.scale_type string

Scale type.

color.categorical_type string

color.categorical_palette colors

Palette.

color.categorical_extend boolean

Auto-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:<br /><hr />Party 1: red<br />Party 2: #4455AA<br />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 scale.

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

Popup

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

X axis

xAxis.axis_position string

Position.

xAxis.y_axis_position string

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

xAxis.numeric_scale_type string

xAxis.linear_min number

Minimum.

xAxis.linear_max number

Maximum.

xAxis.log_min number

Minimum.

xAxis.log_max number

Maximum.

xAxis.line_visible boolean

Draw axis line.

xAxis.line_and_tick_color color

Color.

xAxis.line_and_tick_width number

Width.

xAxis.tick_side string

Side.

xAxis.tick_number number

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

xAxis.tick_length number

Length.

xAxis.tick_padding number

Padding.

xAxis.tick_label_size number

Size.

xAxis.tick_label_color color

Color.

xAxis.tick_label_angle string

Angle.

xAxis.tick_label_weight string

Weight.

xAxis.gridlines_visible boolean

xAxis.gridline_color color

Color.

xAxis.gridline_style string

Style.

xAxis.gridline_width number

Width.

xAxis.title string

Text. Add text to override automatic axis title

xAxis.title_color color

Color.

xAxis.title_size number

Size.

xAxis.title_weight string

Weight.

xAxis.title_padding number

Padding.

Y axis

yAxis.axis_visible boolean

yAxis.numeric_scale_type string

yAxis.linear_min number

Minimum.

yAxis.linear_max number

Maximum.

yAxis.log_min number

Minimum.

yAxis.log_max number

Maximum.

yAxis.line_visible boolean

Draw axis line.

yAxis.line_and_tick_color color

Color.

yAxis.line_and_tick_width number

Width.

yAxis.tick_side string

Side.

yAxis.tick_number number

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

yAxis.tick_length number

Length.

yAxis.tick_padding number

Padding.

yAxis.tick_label_size number

Size.

yAxis.tick_label_color color

Color.

yAxis.tick_label_weight string

Weight.

yAxis.gridlines_visible boolean

yAxis.gridline_color color

Color.

yAxis.gridline_style string

Style.

yAxis.gridline_width number

Width.

yAxis.title string

Text. Add text to override automatic axis title

yAxis.title_color color

Color.

yAxis.title_size number

Size.

yAxis.title_weight string

Weight.

yAxis.title_padding number

Padding.

Legend

size_by_legend.show_legend boolean

size_by_legend.text_color color

Color.

size_by_legend.text_size number

Size.

size_by_legend.title string

Title.

size_by_legend.title_weight string

Weight.

size_by_legend.shape_fill color

Shape fill.

size_by_legend.shape_stroke color

Shape stroke. Hint: set to same value as fill for no stroke

size_by_legend.clip_height number

Max height. Maximum height of shape (relative to root font size)

shade_by_legend_discrete.show_legend boolean

shade_by_legend_discrete.text_color color

Color.

shade_by_legend_discrete.text_size number

Size.

shade_by_legend_discrete.title string

Title.

shade_by_legend_discrete.title_weight string

Weight.

shade_by_legend_discrete.swatch_width number

Width.

shade_by_legend_discrete.swatch_height number

Height.

shade_by_legend_discrete.swatch_radius number

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

shade_by_legend_discrete.orientation string

Orientation.

shade_by_legend_continuous.show_legend boolean

shade_by_legend_continuous.text_color color

Color.

shade_by_legend_continuous.text_size number

Size.

shade_by_legend_continuous.title string

Title.

shade_by_legend_continuous.title_weight string

Weight.

shade_by_legend_continuous.color_band_width number

Width.

shade_by_legend_continuous.color_band_height number

Height.

shade_by_legend_continuous.color_band_radius number

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

Controls

control_text_color color

Text color.

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

button_style.background color

Background.

button_style.font_color color

Text color.

button_style.button_styles_advanced boolean

Advanced.

button_style.background_selected color

Selected background.

button_style.font_color_selected color

Selected text color.

button_style.border_color color

Color.

button_style.border_width number

Width.

button_style.border_transparency number

Transparency.

button_style.border_radius number

Radius.

dropdown_style.background color

Background.

dropdown_style.font_color color

Text color.

dropdown_style.border_styles_advanced boolean

Advanced.

dropdown_style.border_style string

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

dropdown_style.border_width number

Width.

dropdown_style.border_color color

Color.

dropdown_style.border_transparency number

Transparency.

dropdown_style.border_radius number

Radius.

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

number_format.prefix string

Prefix. Text to place in front of number

number_format.suffix string

Suffix. Text to place after number

number_format.n_dec number

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

number_format.strip_zeros boolean

Remove trailing zeros.

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

number_format.transform_labels boolean

Multiply/divide values.

number_format.transform string

number_format.multiply_divide_constant number

number_format.exponentiate_constant number

Layout

Layout

layout.body_font font

Font.

layout.max_width number

Maximum width. Leave blank to stretch to container width

layout.background_color_enabled boolean

Color.

layout.background_image_enabled boolean

Image.

layout.background_color color

Color.

layout.background_image_src url

Image URL.

layout.background_image_size string

Size.

layout.background_image_position string

Position.

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

Styling.

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

Styling.

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

Styling.

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.

layout.header_border string

layout.header_border_width number

Width.

layout.header_border_color color

Color.

layout.header_border_style string

Style.

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

Size.

layout.footer_text_color color

Color.

layout.footer_align string

Alignment.

layout.footer_logo_enabled boolean

layout.footer_logo_src url

Image.

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.

non_header_font.name string

Non header font name.

non_header_font.url string

Non header font url.