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/line-bar-pie",
    version: "17",
    bindings: {
        data: {
            label: 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/line-bar-pie",
    version: "17",
    bindings: {
        data: {
            label: 0, // index of a column in your data
            value: [1, 2, ...], // index(es) of column(s) in your data
            facet: 3, // index of a column in your data
            filter: 4, // index of a column in your data
            metadata: [5, 6, ...], // 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/line-bar-pie",
    version: "17",
    bindings: {
        data: {
            label: "DataHeader1",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/line-bar-pie",
    version: "17",
    bindings: {
        data: {
            label: "DataHeader1",
            value: ["DataHeader2", "DataHeader3", ...],
            facet: "DataHeader4",
            filter: "DataHeader5",
            metadata: ["DataHeader6", "DataHeader7", ...],
        }
    },
    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/line-bar-pie",
    version: "17",
    data: {
    data: [
        {
            label: ...,
            value: [...],
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/line-bar-pie",
    version: "17",
    data: {
    data: [
        {
            label: ...,
            value: [...],
            facet: ...,
            filter: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

• data.label: A column of names or times
• data.value: One or more columns of numbers
• data.facet: If specified and “Grid of charts” view is on, creates a separate mini chart for each value found in the column.
• data.filter: Use this column to create a user-facing row control; to create a column filter use the “Series filter” option in the settings panel instead.
• data.metadata: One or more columns of information to include in custom popups

Template settings

Options for opts.state.

Chart type

chart_type string

secondary_series number

Number of series to show on right axis. Sets how many of your specified value columns are treated as lines. Counts from the start, so if you want, say, column B as a line and A as a column, set the order in the column settings to "B,A".

facet_layout string

Grid mode. “Grid of charts” creates a mini chart for each series (or each value in your ”Charts grid” column, if specified)

height_mode string

Height mode. In “Fill space” mode the graphic will fill the container (which by default will be the the standard Flourish responsive chart size). In “Aspect ratio” mode you set the aspect ratio of the plot and the container will be updated to acommodate it (not supported when embedded in a simple fixed-height iframe). "Auto" uses fill space but switches to "Aspect ratio" if there are too many charts for the space.

bar_height number

Bar size. Approximate height of bar. Exact height depends on padding and label style. Ignored if chart is embedded at a fixed height. Specifed in rems, a multiple of the base font size.

facet_aspect number

Aspect (desktop). Height of the plot, as % of width

facet_aspect_mobile number

Aspect (mobile). Height of the plot, as % of width

facet_aspect_breakpoint number

Breakpoint. The width at which mobile mode ends and desktop begins

sort_mode string

Sort mode.

sort_direction string

Grid of charts

facet_fixed_cols boolean

Number of columns. In Auto mode, the number of columns will change with screen size

facet_min_w number

Min chart width. Determines how many columns of charts there should be in the grid. Ignored if you specify a fixed number of columns.

facet_cols number

Fixed number of columns.

facet_gutter_w number

Horizontal margin.

facet_gutter_h number

Vertical margin.

x_axis_matching boolean

Same across grid. Ensure the x scale is the same across the grid

x_axis_last_row_only boolean

One row only. Only show the x axis on the first or last row, where possible

y_axis_matching boolean

Same across grid. Ensure the y scale is the same across the grid

y_axis_first_col_only boolean

First column only. Only show the y axis on the first column of the grid, where possible

y_secondary_axis_matching boolean

Same across grid. Ensure the secondary y scale is the same across the grid

y_secondary_axis_last_col_only boolean

Last column only. Only show the secondary y axis on the last column of the grid, where possible

facet_header_font_size number

Size. In rems (multiple of base font size)

facet_title_align string

Alignment.

facet_header_color_mode string

Color mode.

facet_header_color color

Color.

facet_header_bg string

Background.

facet_header_bg_mode string

Color mode.

facet_header_bg_color color

Color.

Controls & filters

series_filter_mode string

Series filter. Filter control for series/columns. Use the animation settings panel to determine whether series animate when changing the filter. Except in single select mode, the user can also filter by clicking on the legend, unless that setting has been disabled.

series_control_multi_text string

Placeholder text.

series_control_multi_none_text string

No more results text.

max_series number

Max series to show. Limits the number of series/columns that will be visualized at once

series_control_single_all boolean

Include "All".

series_control_single_all_text string

Name for "All".

series_control_single.control_type string

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

series_control_single.control_styles boolean

Adv..

series_control_single.button_group boolean

Grouped.

series_control_single.button_group_width_mode string

Button group width.

series_control_single.button_group_width_fixed number

Width.

series_control_single.dropdown_width_mode string

Dropdown width.

series_control_single.dropdown_width_fixed number

Width.

series_control_single.slider_background_color color

Background.

series_control_single.slider_font_color color

Text.

series_control_single.slider_handle_color color

Handle.

series_control_single.slider_width number

Width.

series_control_single.slider_margin number

Label width.

series_control_single.slider_handle_height number

Height.

series_control_single.slider_track_height number

Track height.

series_control_single.slider_play_button boolean

Play button.

series_control_single.slider_loop boolean

Loop.

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

series_control_single.slider_restart_pause number

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

series_control_single.sort string

Sorting.

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

row_filter_control_all boolean

Include "All".

row_filter_control_all_text string

Name for "All".

row_filter_control.control_type string

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

row_filter_control.control_styles boolean

Adv..

row_filter_control.button_group boolean

Grouped.

row_filter_control.button_group_width_mode string

Button group width.

row_filter_control.button_group_width_fixed number

Width.

row_filter_control.dropdown_width_mode string

Dropdown width.

row_filter_control.dropdown_width_fixed number

Width.

row_filter_control.slider_background_color color

Background.

row_filter_control.slider_font_color color

Text.

row_filter_control.slider_handle_color color

Handle.

row_filter_control.slider_width number

Width.

row_filter_control.slider_margin number

Label width.

row_filter_control.slider_handle_height number

Height.

row_filter_control.slider_track_height number

Track height.

row_filter_control.slider_play_button boolean

Play button.

row_filter_control.slider_loop boolean

Loop.

row_filter_control.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_control.slider_restart_pause number

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

row_filter_control.sort string

Sorting.

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

log_control_y_visible boolean

Show log control for Y axis.

log_control_y.control_type string

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

log_control_y.control_styles boolean

Adv..

log_control_y.button_group boolean

Grouped.

log_control_y.button_group_width_mode string

Button group width.

log_control_y.button_group_width_fixed number

Width.

log_control_y.dropdown_width_mode string

Dropdown width.

log_control_y.dropdown_width_fixed number

Width.

log_control_y.slider_background_color color

Background.

log_control_y.slider_font_color color

Text.

log_control_y.slider_handle_color color

Handle.

log_control_y.slider_width number

Width.

log_control_y.slider_margin number

Label width.

log_control_y.slider_handle_height number

Height.

log_control_y.slider_track_height number

Track height.

log_control_y.slider_play_button boolean

Play button.

log_control_y.slider_loop boolean

Loop.

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

log_control_y.slider_restart_pause number

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

log_control_y.sort string

Sorting.

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

log_control_y_text_linear string

Linear text.

log_control_y_text_log string

Log text.

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.

Colors

color_mode string

Color mode.

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:

---

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

Lines, dots and areas

line_width number

Width. In rems, a multiple of the page's base font size

line_opacity number

Opacity.

line_curve string

Line curve.

line_dash_items text

Dashed lines. Specify the series that you would like to display with a dashed line. Multiple dashed lines can be set using multiple lines. For example:

---

Party 1
Party 2
Party 3

line_dash_width number

Dash width.

line_dash_space_width number

Space width.

line_interpolate boolean

Missing data points.

area_opacity number

Opacity.

dot_opacity number

Opacity.

dot_radius number

Radius. In rems, a multiple of the page's base font size

dot_radius_last number

Final dot scale (%). Making the last point on a line larger can help emphasise the final value.

dot_hollow boolean

Hollow.

Bars

column_padding_inner number

Spacing (main). Space between bar stacks or groups, as a % of the width of a whole bar stack or group

column_padding_in_group number

Spacing (in group). Space between bars in groups, as a % of the width of a single bar in the group. Ignored if only a single series is selected.

column_padding_stack number

Spacing (in stack). Space each bar in the stack, in tenths of a rem (base font size)

column_opacity number

Bar opacity.

Segments

donut_inner_radius number

Doughnut hole (%).

donut_corner_radius number

Corner curve (pixels).

donut_pad_angle number

Segment padding (degrees).

donut_auto_scale boolean

Scale pies based on data. Scale each pie chart in the grid so that the area of each segment reflect its value

Labels

bar_labels_above boolean

Label style.

bar_labels_color color

Color.

bar_labels_font_size number

Size.

bar_labels_weight string

line_end_labels boolean

Show labels on lines.

line_end_labels_font_size number

Font size.

line_end_labels_width number

Space. The margin added to the right of each chart for the line labels

line_end_labels_weight string

labels boolean

Show labels on data points.

labels_hide_overlaps boolean

Hide overlapping labels.

labels_dot_center boolean

Position labels on center of dot.

labels_column_align string

Bar label alignemnt. The final option "above" option puts the labels above the bars in standard column charts but falls back to top alignment in stacked charts, where the space above the stack is reserved for stack total labels

labels_column_padding number

Padding. Space above or below, as a proportion of the font size.

labels_bar_align string

Label alignemnt. In stacked bar charts the final "outside bar" option falls back to right alignment, since the space after the stack is reserved for stack total labels (see below)

labels_bar_autohide boolean

Hide if too big. Turn off to force labels to show, even if they will overflow the bars. Ignored when labels are not inside the bars.

labels_color_mode string

Text color. Contrast mode is black or white depending on the color of the data point (or the color of the background in the case of column chart label positioned over the background)

labels_fixed_color color

Color.

labels_font_size_mode string

Text size.

labels_font_size number

Size.

labels_bg_mode string

Text background. A background can make the text more readable by increasing contrast. "Auto" mode enables a background in all cases except where the labels are over the bars.

labels_bg_size number

Size. Size of the background, as % of text size

labels_font_weight string

Bold.

labels_content string

Label content.

stack_labels boolean

Show labels for stack totals. You may need to update your axis mins/maxes to create space for these labels

stack_labels_color color

Color.

stack_labels_font_size_mode string

Text size.

stack_labels_font_size number

Size.

stack_labels_weight string

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

Configure default min/max.

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

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

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_max_lines number

Max lines.

x.tick_label_line_height number

Line height.

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

Configure default min/max.

y.nice boolean

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

y.zero_axis string

Include zero. Whether to extend the axis to include zero if the data values are all positive or all negative. Ignored for date and categorical scales, and overridden by any specified min/max.

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_max_lines number

Max lines.

y.tick_label_line_height number

Line height.

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

Y axis (right)

y2.axis_visible boolean

y2.numeric_scale_type string

Type.

y2.linear_min number

Min.

y2.linear_max number

Max.

y2.log_min number

Min.

y2.log_max number

Max.

y2.datetime_min string

Min (date).

y2.datetime_max string

Max (date).

y2.show_scale_settings boolean

Configure default min/max.

y2.nice boolean

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

y2.zero_axis string

Include zero. Whether to extend the axis to include zero if the data values are all positive or all negative. Ignored for date and categorical scales, and overridden by any specified min/max.

y2.title_mode string

Type.

y2.title string

Text.

y2.title_styling boolean

Styling.

y2.title_weight string

Weight.

y2.title_color color

Color.

y2.title_size number

Size.

y2.title_padding number

Padding.

y2.tick_label_position string

Position.

y2.tick_label_styling boolean

Styling.

y2.tick_label_size number

Size.

y2.tick_label_color color

Color.

y2.tick_padding number

Padding.

y2.tick_label_angle string

Angle.

y2.tick_label_weight string

Weight.

y2.tick_label_max_lines number

Max lines.

y2.tick_label_line_height number

Line height.

y2.tick_label_space_mode string

Space mode.

y2.tick_label_space number

Space.

y2.tick_mode string

Mode.

y2.tick_number number

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

y2.tick_custom text

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

y2.line_and_tick_color color

Line color.

y2.line_and_tick_width number

Line width.

y2.tick_length number

Tick length.

y2.tick_side string

Side.

y2.line_visible boolean

Axis line.

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

y2.gridlines_visible boolean

y2.gridlines_styling boolean

Styling.

y2.gridline_color color

Color.

y2.gridline_style string

Style.

y2.gridline_width number

Width.

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

y2.gridline_category_dividers_extend boolean

Extend. Extends the dividers into the axis margins

Plot background

chart_bg.background_color_enabled boolean

Color.

chart_bg.background_image_enabled boolean

Image.

chart_bg.background_color color

Color.

chart_bg.background_image_src url

Image URL.

chart_bg.background_image_size string

Size.

chart_bg.background_image_position string

Position.

Number and date formatting

label_data_type string

Data type.

datetime_input_format string

Format in data sheet. The date/time format in the data sheet. Leave as “Auto” for Flourish to make a best guess. If it 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.

x_axis_date_format string

Display format. The date/time format to show in the graphic. If it 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.

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

number_format_secondary.prefix string

Prefix. Text to place in front of number

number_format_secondary.suffix string

Suffix. Text to place after number

number_format_secondary.n_dec number

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

number_format_secondary.advanced boolean

Advanced.

number_format_secondary.negative_sign string

Styling of negative numbers.

number_format_secondary.strip_zeros boolean

Remove trailing zeros.

number_format_secondary.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_secondary.transform_labels boolean

Multiply/divide values.

number_format_secondary.transform string

number_format_secondary.multiply_divide_constant number

number_format_secondary.exponentiate_constant number

Legend

legend_mode string

Legend mode. “Auto” mode hides the legend in certain situations, such as when each color is already explained by the chart titles in a grid of charts

legend_filter_mode string

Click legend to filter data. Ignored in certain situations, such as when shading by series and using a series control

legend.show_legend boolean

legend.text_color color

Color.

legend.text_size number

Size.

legend.title_mode string

Title mode.

legend.title string

Title.

legend.title_weight string

Weight.

legend.swatch_width number

Width.

legend.swatch_height number

Height.

legend.swatch_radius number

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

legend.order_override text

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

legend.orientation string

Orientation.

legend_position string

Legend position.

text_legend string

text_legend_title boolean

Title.

text_legend_subtitle boolean

Subtitle.

text_legend_bold boolean

Bold. If checked, always use bold for colored items

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. Use {{VALUE}} to include the numerical value of the current data point, or {{SERIES}} to display its series name. For any other selected columns use {{column_name}}. 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

show_series_text boolean

Set series info in popups. Allows you to add information about each series/column (e.g. each line) to the popups. Note: This is incompatible with custom popup content.

popup_series_text text

Popup content for series. Adds content to the popup about the series. Separate column name and text with a double colon. For example:

---

Series 1 :: Comment about Series 1
Series 2 :: Comment about series 2

Axis highlights

anno_x_enabled boolean

Show highlights on the x axis.

anno_x_lines text

One per line, in format “My label :: 2012”. You can optionally also specify a color using the format “My label :: 2012 :: #44CCCC”. For visualizations containing a grid of mini charts, you can also apply the annotation on only a specific chart using the format, e.g. “My label :: 2012 :: #44CCCC :: Chart name”.

anno_x_line_color color

Color.

anno_x_line_width number

Width.

anno_x_line_dash number

Dash.

anno_x_areas text

One per line, in format “My label :: 2013 >> 2015”. You can optionally also specify a color using the format “My label :: 2013 >> 2015 :: #44CCCC”. For visualizations containing a grid of mini charts, you can also apply the annotation on only a specific chart using the format, e.g. “My label :: 2013 >> 2015 :: #44CCCC :: Chart name”.

anno_x_fill_color color

Area.

anno_x_label_color color

Text.

anno_x_fill_opacity number

Area opacity.

anno_x_label_align string

Labels.

anno_x_label_vertical boolean

Vertical.

anno_x_font_size number

Font size.

anno_x_stack string

Above or below data.

anno_y_enabled boolean

Show highlights on the y axis.

anno_y_lines text

One per line, in format “My label :: 5000”. You can optionally also specify a color using the format “My label :: 5000 :: #44CCCC”. For visualizations containing a grid of mini charts, you can also apply the annotation on only a specific chart using the format, e.g. “My label :: 5000 :: #44CCCC :: Chart name”.

anno_y_line_color color

Color.

anno_y_line_width number

Width.

anno_y_line_dash number

Dash.

anno_y_areas text

One per line, in format “My label :: 2000 >> 8000”. You can optionally also specify a color using the format “My label :: 2000 >> 8000 :: #44CCCC”. For visualizations containing a grid of mini charts, you can also apply the annotation on only a specific chart using the format, e.g. “My label :: 2000 >> 8000” :: #44CCCC :: Chart name”.

anno_y_fill_color color

Area.

anno_y_label_color color

Text.

anno_y_fill_opacity number

Area opacity.

anno_y_label_align string

Labels.

anno_y_font_size number

Font size.

anno_y_stack string

Above or below data.

Animations

data_trans_duration number

Animation duration. The duration, in milliseconds, of transitions – for example between two slides in a story

animate_on_load boolean

Animate on load.

data_trans_bind_series boolean

Only animate series with same name. Determines how animations work when the data changes (e.g. between slides in a story). When this is on, series (e.g. lines) will attempt to animate to become another line only if they have the same name (i.e. the same column header).

data_trans_bind_data_points boolean

Only animate points with same label. Determines how animations work when the data changes (e.g. between slides in a story). When this is on, data points (e.g. dots or bars) will attempt to animate to become other data points if they have the same label (e.g. date or category).

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