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_regions: [
            [ "Geo_regionsColumn1Value1", "Geo_regionsColumn2Value1",
            [ "Geo_regionsColumn1Value2", "Geo_regionsColumn2Value2",
            [ "Geo_regionsColumn1Value3", "Geo_regionsColumn2Value3",
            ...
        ],
        geo_points: [
            [ "Geo_pointsColumn1Value1", "Geo_pointsColumn2Value1",
            [ "Geo_pointsColumn1Value2", "Geo_pointsColumn2Value2",
            [ "Geo_pointsColumn1Value3", "Geo_pointsColumn2Value3",
            ...
        ]
    }
}

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: "14",
    bindings: {
        data: {
            
        },
        geo_regions: {
            
        },
        geo_points: {
            
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ],
        geo_regions: [
            [ "Geo_regionsColumn1Value1", "Geo_regionsColumn2Value1",
            [ "Geo_regionsColumn1Value2", "Geo_regionsColumn2Value2",
            [ "Geo_regionsColumn1Value3", "Geo_regionsColumn2Value3",
            ...
        ],
        geo_points: [
            [ "Geo_pointsColumn1Value1", "Geo_pointsColumn2Value1",
            [ "Geo_pointsColumn1Value2", "Geo_pointsColumn2Value2",
            [ "Geo_pointsColumn1Value3", "Geo_pointsColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@flourish/data-explorer",
    version: "14",
    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
            short_label: 7, // index of a column in your data
            geo_region_key: 8, // index of a column in your data
            geo_point_key: 9, // index of a column in your data
            metadata: [10, 11, ...], // index(es) of column(s) in your data
        },
        geo_regions: {
            geo_region_key: 0, // index of a column in your data
            shapes: [1, 2, ...], // index(es) of column(s) in your data
        },
        geo_points: {
            geo_point_key: 0, // index of a column in your data
            lat: 1, // index of a column in your data
            lon: 2, // index of a column in your data
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ],
        geo_regions: [
            [ "Geo_regionsColumn1Value1", "Geo_regionsColumn2Value1",
            [ "Geo_regionsColumn1Value2", "Geo_regionsColumn2Value2",
            [ "Geo_regionsColumn1Value3", "Geo_regionsColumn2Value3",
            ...
        ],
        geo_points: [
            [ "Geo_pointsColumn1Value1", "Geo_pointsColumn2Value1",
            [ "Geo_pointsColumn1Value2", "Geo_pointsColumn2Value2",
            [ "Geo_pointsColumn1Value3", "Geo_pointsColumn2Value3",
            ...
        ]
    }
}

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_regions: [
            { "Geo_regionsHeader1": ..., "Geo_regionsHeader2": ..., ... },
            { "Geo_regionsHeader1": ..., "Geo_regionsHeader2": ..., ... },
            { "Geo_regionsHeader1": ..., "Geo_regionsHeader2": ..., ... },
            ...
        ],
        geo_points: [
            { "Geo_pointsHeader1": ..., "Geo_pointsHeader2": ..., ... },
            { "Geo_pointsHeader1": ..., "Geo_pointsHeader2": ..., ... },
            { "Geo_pointsHeader1": ..., "Geo_pointsHeader2": ..., ... },
            ...
        ]
    }

... 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: "14",
    bindings: {
        data: {
            
        },
        geo_regions: {
            
        },
        geo_points: {
            
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ],
        geo_regions: [
            { "Geo_regionsHeader1": ..., "Geo_regionsHeader2": ..., ... },
            { "Geo_regionsHeader1": ..., "Geo_regionsHeader2": ..., ... },
            { "Geo_regionsHeader1": ..., "Geo_regionsHeader2": ..., ... },
            ...
        ],
        geo_points: [
            { "Geo_pointsHeader1": ..., "Geo_pointsHeader2": ..., ... },
            { "Geo_pointsHeader1": ..., "Geo_pointsHeader2": ..., ... },
            { "Geo_pointsHeader1": ..., "Geo_pointsHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/data-explorer",
    version: "14",
    bindings: {
        data: {
            categoryColumns: ["DataHeader1", "DataHeader2", ...],
            numericColumns: ["DataHeader3", "DataHeader4", ...],
            filter: "DataHeader5",
            id: "DataHeader6",
            label: "DataHeader7",
            short_label: "DataHeader8",
            geo_region_key: "DataHeader9",
            geo_point_key: "DataHeader10",
            metadata: ["DataHeader11", "DataHeader12", ...],
        },
        geo_regions: {
            geo_region_key: "Geo_regionsHeader1",
            shapes: ["Geo_regionsHeader2", "Geo_regionsHeader3", ...],
        },
        geo_points: {
            geo_point_key: "Geo_pointsHeader1",
            lat: "Geo_pointsHeader2",
            lon: "Geo_pointsHeader3",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ],
        geo_regions: [
            { "Geo_regionsHeader1": ..., "Geo_regionsHeader2": ..., ... },
            { "Geo_regionsHeader1": ..., "Geo_regionsHeader2": ..., ... },
            { "Geo_regionsHeader1": ..., "Geo_regionsHeader2": ..., ... },
            ...
        ],
        geo_points: [
            { "Geo_pointsHeader1": ..., "Geo_pointsHeader2": ..., ... },
            { "Geo_pointsHeader1": ..., "Geo_pointsHeader2": ..., ... },
            { "Geo_pointsHeader1": ..., "Geo_pointsHeader2": ..., ... },
            ...
        ]
    }
}

(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: "14",
    data: {
    data: [
        {
            categoryColumns: [...],
            numericColumns: [...],
            metadata: [...]
        },
        ...
    ],
    geo_regions: [
        {
            shapes: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/data-explorer",
    version: "14",
    data: {
    data: [
        {
            categoryColumns: [...],
            numericColumns: [...],
            filter: ...,
            id: ...,
            label: ...,
            short_label: ...,
            geo_region_key: ...,
            geo_point_key: ...,
            metadata: [...]
        },
        ...
    ],
    geo_regions: [
        {
            geo_region_key: ...,
            shapes: [...]
        },
        ...
    ],
    geo_points: [
        {
            geo_point_key: ...,
            lat: ...,
            lon: ...
        },
        ...
    ]
},
    ...
}

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.short_label: Column to use as a label for each item if there's insufficient space for the original label
• data.geo_region_key: Unique id for joining boundary data in the "Geo Regions" datasheet. This column must contain values that match "Geo region key" values in "Geo Regions".
• data.geo_point_key: Unique id for joining point data in the "Geo Points" datasheet. Must contain values that match "Geo point key" values in "Geo Points".
• data.metadata: Makes additional columns (text, emoji, image URLs, etc) available in custom popups
• geo_regions.geo_region_key: Unique id for joining boundary data. Must contain ids that match the "Geo region key" values in "Data".
• geo_regions.shapes: Columns containing GeoJSON geometry that describe a boundary (typically geometry type will be MultiPolygon or Polygon)
• geo_points.geo_point_key: Unique id for joining latitude/longitude data. Most contain ids that match the "Geo point key" values in "Data".
• geo_points.lat: lat
• geo_points.lon: lon

Template settings

Options for opts.state.

Data Explorer

scatter_max_radius number

Scatter plot maximum radius. Maximum radius of scatter points (as a percentage of chart width)

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.

prevent_clipping boolean

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

renderer string

Renderer. Use SVG or Canvas for rendering

draw_smaller_points_on_top boolean

Draw smaller points on top. Applies to scatter plots and maps. If true, smaller points are drawn on top of larger points. If false, larger points are drawn in front of smaller points.

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

text_color color

Text color.

stroke_color color

Stroke color.

stroke_width number

Stroke width.

scale_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_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.numeric_type string

Scale type.

color.binning boolean

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_mode string

Binning mode.

color.bin_count number

Number of bins.

color.bin_thresholds string

Custom thresholds. Write your custom thresholds, separated by a ";" For example "5;10;15". Bins are created between the domain minimum and the first threshold, between each threshold and between the final threshold and the domain maximum. Therefore for the example "5;10;15" four bins are created. (The domain is the minimum and maximum values of your data.)

color.sequential_palette string

Palette.

color.sequential_reverse boolean

Reverse.

color.sequential_custom_min color

Minimum color.

color.sequential_custom_max color

Maximum color.

color.sequential_color_space string

Color space.

color.sequential_custom_domain boolean

Domain.

color.sequential_domain_min number

Min.

color.sequential_domain_max number

Max.

color.diverging_palette string

Palette.

color.diverging_reverse boolean

Reverse.

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

color.diverging_custom_domain boolean

Domain.

color.diverging_domain_min number

Min.

color.diverging_domain_mid number

Mid.

color.diverging_domain_max number

Max.

Item labels

item_label_min_size number

Minimum size. Labels smaller than the specified size will be hidden. Specified in rems, a multiple of the base font size.

item_label_max_size number

Maximum size. Labels larger than the specified size will be hidden. Specified in rems, a multiple of the base font size.

item_label_padding number

Padding. The amount of space between the label and the item boundary, as a percentage of the item size

Group labels

group_label_size number

Size. Sets size of group labels. Specified in rems, a multiple of the base font size.

group_label_margin number

Space for label. Sets size of space allocated to group labels

group_label_color color

Colour.

group_label_weight string

Weight.

group_sort_method string

Sort groups. Sets how the groups will be sorted. If 'None' is chosen the group labels will be in the same order as in the data sheet.

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

Type.

xAxis.linear_min number

Min.

xAxis.linear_max number

Max.

xAxis.log_min number

Min.

xAxis.log_max number

Max.

xAxis.datetime_min string

Min (date).

xAxis.datetime_max string

Max (date).

xAxis.flip boolean

Flip axis.

xAxis.show_scale_settings boolean

Configure default min/max.

xAxis.nice boolean

Round min/max. When enabled, scales automatically extend to "nice" rounded start/end values, such as hundreds or whole years. Overridden by any explicitly specified scale min and max.

xAxis.zero_axis string

Include zero. Whether to extend the axis to include zero if the data values are all positive or all negative. Overridden by any explicitly specified scale min and max.

xAxis.title_mode string

Type.

xAxis.title string

Text.

xAxis.title_styling boolean

Styling.

xAxis.title_weight string

Weight.

xAxis.title_color color

Color.

xAxis.title_size number

Size.

xAxis.title_padding number

Padding.

xAxis.tick_label_position string

Position.

xAxis.tick_label_styling boolean

Styling.

xAxis.tick_label_size number

Size.

xAxis.tick_label_color color

Color.

xAxis.tick_padding number

Padding.

xAxis.tick_label_angle string

Angle.

xAxis.tick_label_weight string

Weight.

xAxis.tick_label_max_lines number

Max lines.

xAxis.tick_label_line_height number

Line height.

xAxis.tick_label_space_mode string

Space mode.

xAxis.tick_label_space number

Space.

xAxis.tick_mode string

Mode.

xAxis.tick_number number

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

xAxis.tick_custom text

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

xAxis.line_and_tick_color color

Line color.

xAxis.line_and_tick_width number

Line width.

xAxis.tick_length number

Tick length.

xAxis.tick_side string

Tick side.

xAxis.line_visible boolean

Axis line.

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

xAxis.gridlines_visible boolean

xAxis.gridlines_styling boolean

Styling.

xAxis.gridline_color color

Color.

xAxis.gridline_style string

Style.

xAxis.gridline_width number

Width.

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

xAxis.gridline_category_dividers_extend boolean

Extend. Extends the dividers into the axis margins.

Y axis

yAxis.axis_visible boolean

yAxis.numeric_scale_type string

Type.

yAxis.linear_min number

Min.

yAxis.linear_max number

Max.

yAxis.log_min number

Min.

yAxis.log_max number

Max.

yAxis.datetime_min string

Min (date).

yAxis.datetime_max string

Max (date).

yAxis.flip boolean

Flip axis.

yAxis.show_scale_settings boolean

Configure default min/max.

yAxis.nice boolean

Round min/max. When enabled, scales automatically extend to "nice" rounded start/end values, such as hundreds or whole years.

yAxis.zero_axis string

Include zero. Whether to extend the axis to include zero if the data values are all positive or all negative.

yAxis.title_mode string

Type.

yAxis.title string

Text.

yAxis.title_styling boolean

Styling.

yAxis.title_position string

Position.

yAxis.title_weight string

Weight.

yAxis.title_color color

Color.

yAxis.title_size number

Size.

yAxis.title_padding number

Padding.

yAxis.tick_label_position string

Position.

yAxis.tick_label_styling boolean

Styling.

yAxis.tick_label_size number

Size.

yAxis.tick_label_color color

Color.

yAxis.tick_padding number

Padding.

yAxis.tick_label_angle string

Angle.

yAxis.tick_label_weight string

Weight.

yAxis.tick_label_max_lines number

Max lines.

yAxis.tick_label_line_height number

Line height.

yAxis.tick_label_space_mode string

Space mode.

yAxis.tick_label_space number

Space.

yAxis.tick_mode string

Mode.

yAxis.tick_number number

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

yAxis.tick_custom text

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

yAxis.line_and_tick_color color

Line color.

yAxis.line_and_tick_width number

Line width.

yAxis.tick_length number

Tick length.

yAxis.tick_side string

Side.

yAxis.line_visible boolean

Axis line.

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

yAxis.gridlines_visible boolean

yAxis.gridlines_styling boolean

Styling.

yAxis.gridline_color color

Color.

yAxis.gridline_style string

Style.

yAxis.gridline_width number

Width.

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

yAxis.gridline_category_dividers_extend boolean

Extend. Extends the dividers into the axis margins

Map

geo_zoom_enabled boolean

Zoom.

show_all_geojson_regions boolean

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

geo_region_default_color color

Default region color. Color of GeoJSON regions that aren't joined to data

geo_point_show_labels boolean

Show geo point labels.

geo_point_opacity number

Geo point opacity.

geo_point_max_radius number

Geo point maximum radius. Maximum radius of geo points (as a percentage of chart width)

geo_apply_zoom_scale_to_points boolean

Apply zoom scale to geo points. If true, geo points will be scaled in same manner as regions when zooming

geo_fit_to_points boolean

Fit to geo points. Fit view to geo points

Legend

legend_container.alignment string

Alignment.

legend_container.orientation string

Orientation.

legend_container.title_weight string

Title weight.

legend_container.text_weight string

Text weight.

legend_container.text_color color

Color.

legend_container.text_size number

Size.

size_by_legend.show_legend boolean

size_by_legend.title_mode string

Title mode.

size_by_legend.title string

Title.

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)

size_by_legend.small_symbol_size number

Small/large proportion. Proportion of the small symbol's value compared to the big symbol's value. 0.5 means it's half the value of the big symbol.

shade_by_legend_discrete.show_legend boolean

shade_by_legend_discrete.title_mode string

Title mode.

shade_by_legend_discrete.title string

Title.

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

Padding. Padding between legend items (in rems)

shade_by_legend_discrete.order_override text

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

shade_by_legend_discrete.icon_height number

Height. Height of icon (relative to the base font size)

shade_by_legend_discrete.icon_color color

Color. Fallback color (icon color if not determined by template)

shade_by_legend_discrete.max_width number

Max width.

shade_by_legend_discrete.orientation string

Orientation.

shade_by_legend_continuous.show_legend boolean

shade_by_legend_continuous.title_mode string

Title mode.

shade_by_legend_continuous.title string

Title.

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)

shade_by_legend_continuous.binned_label_mode string

Binned label mode.

shade_by_legend_continuous.binned_label_custom string

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

shade_by_legend_continuous.legend_min number

Legend min.

shade_by_legend_continuous.additional_min_label string

Custom min label.

shade_by_legend_continuous.legend_max number

Legend max.

shade_by_legend_continuous.additional_max_label string

Custom max label.

Search box

search_enabled boolean

search_box_size number

Box size.

search_bg_color color

Background.

search_bg_opacity number

Opacity.

search_box_stroke number

Stroke. Strongness of stroke color

search_text_color color

Text color.

search_icon_color color

Icon color.

search_box_radius number

Roundness.

search_placeholder string

Placeholder text. The text to show when the search field is empty

search_dropdown boolean

Always show dropdown suggestions. If disabled it will only show suggestions after typing 2 characters

search_expanded boolean

Always expand searchbox.

Popups and panels

popup.mode string

popup.popup_is_custom boolean

Popup content.

popup.show_popup_styles boolean

Show popup styles.

popup.popup_custom_header html

Popup custom header. 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. You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}}

popup.popup_custom_main html

Popup custom main 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. You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}}

popup.popup_width number

Max width. In rems, multiples of base font size. Leave blank to let the width adjust based on the contents.

popup.popup_font_size number

Text size.

popup.popup_text_color color

Text color.

popup.popup_align string

Align.

popup.popup_background color

Fill color.

popup.popup_background_opacity number

Fill opacity.

popup.popup_padding number

Padding.

popup.popup_radius number

Radius. Corner radius of popup

popup.popup_header_type string

Header style.

popup.popup_header_background color

Background.

popup.popup_header_text_color color

Text.

popup.popup_list_type string

List type.

popup.popup_list_label_weight string

Label weight.

popup.popup_list_separator string

List separator.

popup.popup_shadow boolean

Shadow.

popup.popup_pointer boolean

Pointer.

popup.panel_position string

popup.panel_open_duration number

Open duration.

popup.panel_side_fixed boolean

Always show.

popup.panel_side_default_content text

Placeholder content.

popup.panel_is_custom boolean

Panel content.

popup.show_panel_styles boolean

Show panel styles.

popup.panel_custom_header html

Panel custom header. The text to appear in the panel. 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. You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}}

popup.panel_custom_main html

Panel custom main content. The text to appear in the panel. 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. You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}}

popup.panel_width_overlay number

Width (%).

popup.panel_height_overlay number

Height (%).

popup.panel_width_side number

Width (%).

popup.panel_height_side number

Height (%).

popup.panel_max_width number

Max width (px).

popup.panel_max_height number

Max height (px).

popup.panel_vertical_position string

Vertical position. Choosing "Click position" is especially useful when your visualisation is really tall, this will make sure the panel content is always on top of the element you've clicked on

popup.panel_text_color color

Text color.

popup.panel_font_size number

Text size.

popup.panel_align string

Alignment.

popup.panel_background color

Fill color.

popup.panel_background_opacity number

Fill opacity.

popup.panel_padding number

Padding.

popup.panel_radius number

Radius. Corner radius of panel

popup.panel_list_type string

List type.

popup.panel_list_label_weight string

Label weight.

popup.panel_list_separator string

List separator.

popup.panel_shadow boolean

Shadow.

Controls

control_text_color color

Text color.

narrow_breakpoint number

Mobile breakpoint. If the window width is smaller than this number in pixels, the control panel will become an overlay

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

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.

controls_geo_visible boolean

Map.

controls_geo_shapes_visible boolean

Map shapes.

controls_position_by_1_visible boolean

Position 1.

controls_position_by_2_visible boolean

Position 2.

controls_size_by_visible boolean

Size.

controls_shade_by_visible boolean

Color.

controls_aggregate_by_visible boolean

Aggregation.

controls_filter_visible boolean

Filter.

controls_geo_shapes_label string

Map shapes.

controls_position_by_1_label string

Position 1.

controls_position_by_2_label string

Position 2.

controls_size_by_label string

Size.

controls_shade_by_label string

Color.

controls_aggregate_by_label string

Aggregation.

controls_filter_label string

Filter.

controls_position_by_items text

Position. List of columns to include or exclude in the position dropdown. If blank, all categorical and numerical columns are used.<br />For aggregated values, add ' (mean)', ' (sum)', ' (min)' or ' (max)' after the column name. You can also use 'Count' for the count aggregation.<br />Multiple columns may be specified using separate lines. For example:<br /><hr />Region<br />Forest area (sq. km)<br />Forest area (sq. km) (sum)<br />Count

controls_exclude_position_by_items boolean

Inclusion. If 'Include' is selected only the items in the adjacent list will be included in the dropdown. If 'Exclude' is selected items in the adjacent list will be excluded from the dropdown.

controls_size_by_items text

Size. List of columns to include or exclude in the size dropdown. If blank, all numerical columns are used.<br />For aggregated values, add ' (mean)', ' (sum)', ' (min)' or ' (max)' after the column name. You can also use 'Count' for the count aggregation.<br />Multiple columns may be specified using separate lines. For example:<br /><hr />Forest area (sq. km)<br />Forest area (sq. km) (sum)<br />Count

controls_exclude_size_by_items boolean

Inclusion. If 'Include' is selected only the items in the adjacent list will be included in the dropdown. If 'Exclude' is selected items in the adjacent list will be excluded from the dropdown.

controls_shade_by_items text

Color. List of columns to include or exclude in the position dropdown. If blank, all categorical and numerical columns are used.<br />For aggregated values, add ' (mean)', ' (sum)', ' (min)' or ' (max)' after the column name. You can also use 'Count' for the count aggregation.<br />Multiple columns may be specified using separate lines. For example:<br /><hr />Region<br />Forest area (sq. km)<br />Forest area (sq. km) (sum)<br />Count

controls_exclude_shade_by_items boolean

Inclusion. If 'Include' is selected only the items in the adjacent list will be included in the dropdown. If 'Exclude' is selected items in the adjacent list will be excluded from the dropdown.

controls_aggregate_by_items text

Aggregation. List of columns to include or exclude in the aggregation dropdown. If blank, all categorical columns are used.<br />Multiple columns may be specified using separate lines. For example:<br /><hr />Region<br />Income Group

controls_exclude_aggregate_by_items boolean

Inclusion. If 'Include' is selected only the items in the adjacent list will be included in the dropdown. If 'Exclude' is selected items in the adjacent list will be excluded from the dropdown.

controls_dropdown_sort boolean

Sort dropdown menu items. Enables alphabetical sorting. If turned off, the dropdown will contain first any categorical columns (in the order selected in the column settings), and then any numeric columns.

controls_dropdown_separate_categorical_and_numeric boolean

Keep categorical and numeric items separate. If turned off, categorical and numeric columns will be sorted together alphabetically

hide_controls_toggle boolean

Disable controls toggle in published graphic. When checked, the cog icon for showing/hiding the controls panel is visible only in the visualisation and story editors – not in the published visualisation or story. When making a story you can still lock the panel to be visible or hidden by clicking the cog icon in the story editor.

controls_toggle_size number

Size.

controls_toggle_background color

Background.

controls_toggle_color color

Icon color.

Filter

filter_control_include_all boolean

Include "All" in filter.

filter_control_all_text string

“All” label.

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.advanced boolean

Advanced.

number_format.negative_sign string

Styling of negative numbers.

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

Animations

transition_duration number

Animation duration. The duration of the animation for each item in seconds

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

Weight.

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

Accessibility

layout.screenreader_hide_primary boolean

Screenreader mode for main visual container. Whether the main visual container is visible to screenreaders. (Text in the header and footer are always available to screenreaders.)

layout.screenreader_text_primary text

Screenreader description. A text alternative to the visual content that will only be visible to screenreaders, e.g. “The line chart shows China consistently higher than the other countries since 1990”. Do no replicate your title, since that will also be read by screenreaders.

non_header_font.name string

Non header font name.

non_header_font.url string

Non header font url.