Line, bar and pie charts
Updated 4 years ago to v15.0.2 by Flourish team
How to use this template
How to get started
Upload data with one column containing “labels” (category names, years, etc) and one or more numerical columns of “values” (each of which becomes a line on a line chart, a series of bars on a bar chart, etc). Here's what your data might look like.
Year | London | Paris | Berlin |
2010 | 1 | 4 | 3 |
2020 | 0 | 3 | 6 |
Making a grid of charts
You can use the “Grid of charts” option to display each series in your data on its own mini chart – a visualisation technique called “small multiples”. Data can also be divided into mini charts by specifying a “Charts grid” column. In this case, there will be one chart for each unique value in the selected column. This is useful if your data is arranged in this way, or if you want to create a grid with multiple series on each chart.
FAQ
How do I change the color of some of the bars, but not all of them? First, make sure you’re using a “bar” or "column" chart. Then, under "Chart styles", choose "Shade by row". Finally, specify the colors you want for each row under "Custom colors". (If you'd like to have all the bars the same color except for one or two, a shortcut is first to customise the palette so that there's only one color.)
Tips
- You can use custom colors by typing them as a comma-separated list in to the “Color scheme or custom colors” menu. You can use any named CSS color or hexcode.
- With a grid of line or bar charts, you can choose whether to have the same y axis for all the charts (good for comparing absolute numbers) or to have each chart set its own y-axis based on the data it contains (best for comparing the shape of each series).
- If you make different views of your data and save them as separate visualisations, you can animate between the charts in the Flourish story editor.
API information
This section documents API usage specific to this template, so for an introduction we suggest you refer to the generic API documentation instead.
template: @flourish/line-bar-pie
version: 15
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: "15", 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: "15", 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 metadata: [4, 5, ...], // 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: "15", 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: "15", bindings: { data: { label: "DataHeader1", value: ["DataHeader2", "DataHeader3", ...], facet: "DataHeader4", metadata: ["DataHeader5", "DataHeader6", ...], } }, 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: "15", data: { data: [ { label: ..., value: [...], metadata: [...] }, ... ] }, ... }
And the full list of all possible properties is as follows:
{ template: "@flourish/line-bar-pie", version: "15", data: { data: [ { label: ..., value: [...], facet: ..., 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.metadata: One or more columns of information to include in custom popups
Template settings
Options for opts.state
.
Chart type
chart_type string
Allowed values:
- line (Line chart)
- area_stacked (Area chart (stacked))
- area_prop (Area chart (stacked %))
- area (Area chart (unstacked))
- column_grouped (Column chart (grouped))
- column_stacked (Column chart (stacked))
- column_stacked_prop (Column chart (stacked %))
- bar_grouped (Bar chart (grouped))
- bar_stacked (Bar chart (stacked))
- bar_stacked_prop (Bar chart (stacked %))
- donut (Pie chart)
- column_grouped_line (Dual axis: Lines & columns (grouped))
- column_stacked_line (Dual axis: Lines & columns (stacked))
- column_stacked_prop_line (Dual axis: Lines & columns (stacked %))
- area_stacked_line (Dual axis: Lines & areas (stacked))
- line_line (Dual axis: Lines & lines)
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 column and A as a line, 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) Allowed values:
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. Allowed values:
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. Min: 0.5
facet_aspect number
Aspect. Height of the plot, as % of width
Grid of charts
facet_fixed_cols boolean
Number of columns. In Auto mode, the number of columns will change with screen size Allowed values:
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. Min: 1
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. Allowed values:
facet_header_color_mode string
Color mode. Allowed values:
facet_header_color color
Color.
facet_header_bg string
Background. Allowed values:
facet_header_bg_mode string
Color mode. Allowed values:
facet_header_bg_color color
Color.
Colors
color_mode string
Color mode. Allowed values:
color.scale_type string
Scale type. Allowed values:
color.categorical_type string
Allowed values:
- palette (Palette)
- generated (Generated)
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. Max: 360
color.categorical_color_space string
Allowed values:
- hcl (HCL)
- hsl (HSL)
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. Allowed values:
color.sequential_custom_min color
Minimum color.
color.sequential_custom_max color
Maximum color.
color.sequential_color_space string
Allowed values:
- rgb (RGB)
- lab (LAB)
- hcl (HCL)
- hsl (HSL)
color.sequential_reverse boolean
Reverse scale.
color.diverging_palette string
Palette. Allowed values:
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
Allowed values:
- rgb (RGB)
- lab (LAB)
- hcl (HCL)
- hsl (HSL)
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. Max: 1
line_curve string
Line curve. Allowed values:
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.
area_opacity number
Opacity. Max: 1
dot_opacity number
Opacity. Max: 1
dot_radius number
Radius. In rems, a multiple of the page's base font size Max: 3
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 Max: 100
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. Max: 100
column_opacity number
Bar opacity. Min: 0.1 Max: 1
Segments
donut_inner_radius number
Doughnut hole (%). Max: 99
donut_corner_radius number
Corner curve (pixels).
donut_pad_angle number
Segment padding (degrees). Max: 10
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. Allowed values:
bar_labels_color color
Color.
bar_labels_font_size number
Size.
bar_labels_weight string
Allowed values:
- 600 (Bold)
- 400 (Normal)
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
Allowed values:
- 600 (Bold)
- 400 (Normal)
labels boolean
Show labels on each data point.
labels_dot_center boolean
Position labels on center of dot.
labels_column_align string
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 Allowed values:
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) Allowed values:
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. Allowed values:
labels_fixed_color color
Color.
labels_font_size_mode string
Text size. Allowed values:
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. Allowed values:
labels_bg_size number
Size. Size of the background, as % of text size Max: 100
labels_font_weight string
Bold. Allowed values:
labels_content string
Label content. Allowed values:
stack_labels boolean
Show totals for each stack. 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. Allowed values:
stack_labels_font_size number
Size.
stack_labels_weight string
Allowed values:
- 600 (Bold)
- 400 (Normal)
X axis
x.axis_position string
Position. Allowed values:
x.y_axis_position string
Y value. Vertical position of the x axis on the y scale
x.numeric_scale_type string
Type. Allowed values:
x.linear_min number
Min.
x.linear_max number
Max.
x.log_min number
Min.
x.log_max number
Max.
x.datetime_min string
Min (date).
x.datetime_max string
Max (date).
x.title_mode string
Type. Allowed values:
x.title string
Text.
x.title_styling boolean
Styling.
x.title_weight string
Weight. Allowed values:
x.title_color color
Color.
x.title_size number
Size.
x.title_padding number
Padding.
x.tick_label_position string
Position. Allowed values:
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. Allowed values:
x.tick_label_weight string
Weight. Allowed values:
x.tick_label_space_mode string
Space mode. Allowed values:
x.tick_label_space number
Space.
x.tick_mode string
Mode. Allowed values:
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. Allowed values:
x.line_visible boolean
Axis line.
x.gridlines_visible boolean
Allowed values:
- true (On)
- false (Off)
x.gridlines_styling boolean
Styling.
x.gridline_color color
Color.
x.gridline_style string
Style. Allowed values:
x.gridline_width number
Width.
Y axis
y.axis_visible boolean
Allowed values:
- true (Axis visible)
- false (Axis hidden)
y.numeric_scale_type string
Type. Allowed values:
y.linear_min number
Min.
y.linear_max number
Max.
y.log_min number
Min.
y.log_max number
Max.
y.datetime_min string
Min (date).
y.datetime_max string
Max (date).
y.title_mode string
Type. Allowed values:
y.title string
Text.
y.title_styling boolean
Styling.
y.title_weight string
Weight. Allowed values:
y.title_color color
Color.
y.title_size number
Size.
y.title_padding number
Padding.
y.tick_label_position string
Position. Allowed values:
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. Allowed values:
y.tick_label_weight string
Weight. Allowed values:
y.tick_label_space_mode string
Space mode. Allowed values:
y.tick_label_space number
Space.
y.tick_mode string
Mode. Allowed values:
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. Allowed values:
y.line_visible boolean
Axis line.
y.gridlines_visible boolean
Allowed values:
- true (On)
- false (Off)
y.gridlines_styling boolean
Styling.
y.gridline_color color
Color.
y.gridline_style string
Style. Allowed values:
y.gridline_width number
Width.
Y axis (right)
y2.axis_visible boolean
Allowed values:
- true (Axis visible)
- false (Axis hidden)
y2.numeric_scale_type string
Type. Allowed values:
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.title_mode string
Type. Allowed values:
y2.title string
Text.
y2.title_styling boolean
Styling.
y2.title_weight string
Weight. Allowed values:
y2.title_color color
Color.
y2.title_size number
Size.
y2.title_padding number
Padding.
y2.tick_label_position string
Position. Allowed values:
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. Allowed values:
y2.tick_label_weight string
Weight. Allowed values:
y2.tick_label_space_mode string
Space mode. Allowed values:
y2.tick_label_space number
Space.
y2.tick_mode string
Mode. Allowed values:
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. Allowed values:
y2.line_visible boolean
Axis line.
y2.gridlines_visible boolean
Allowed values:
- true (On)
- false (Off)
y2.gridlines_styling boolean
Styling.
y2.gridline_color color
Color.
y2.gridline_style string
Style. Allowed values:
y2.gridline_width number
Width.
Plot background
chart_bg.background_color_enabled boolean
Color. Allowed values:
chart_bg.background_image_enabled boolean
Image. Allowed values:
chart_bg.background_color color
Color.
chart_bg.background_image_src url
Image URL.
chart_bg.background_image_size string
Size. Allowed values:
chart_bg.background_image_position string
Position. Allowed values:
Number and date formatting
label_data_type string
Data type. Allowed values:
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. Predefined values:
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. Predefined values:
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. Allowed values:
localization.output_separators string
Number format to display. How the numbers should appear on chart labels Allowed values:
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) Min: -10 Max: 10
number_format.advanced boolean
Advanced.
number_format.negative_sign string
Styling of negative numbers. Allowed values:
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
Allowed values:
- multiply (Multiply by)
- divide (Divide by)
- exponentiate (×10 to the power of)
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) Min: -10 Max: 10
number_format_secondary.advanced boolean
Advanced.
number_format_secondary.negative_sign string
Styling of negative numbers. Allowed values:
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
Allowed values:
- multiply (Multiply by)
- divide (Divide by)
- exponentiate (×10 to the power of)
number_format_secondary.multiply_divide_constant number
number_format_secondary.exponentiate_constant number
Legend
legend_mode string
“Auto” mode hides the legend in some situations when there is already a label explaining each colour in the chart Allowed values:
legend.show_legend boolean
Allowed values:
- true (Enabled)
- false (Disabled)
legend.text_color color
Color.
legend.text_size number
Size.
legend.title string
Title.
legend.title_weight string
Weight. Allowed values:
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. Allowed values:
legend_position string
Legend position. Allowed values:
text_legend string
Allowed values:
- auto (Auto)
- custom (Custom)
- off (Off)
text_legend_title boolean
Title.
text_legend_subtitle boolean
Subtitle.
text_legend_bold boolean
Bold. If checked, always use bold for colored items
Controls
series_filter_enabled boolean
Show series filter.
series_filter_text string
Placeholder text.
series_filter_none_text string
No more results text.
max_series number
Max number of series to show.
log_control_y_visible boolean
Show log control for Y axis.
log_control_y_width number
Width. Min: 20
log_control_y_text_linear string
Linear text.
log_control_y_text_log string
Log text.
Popups
popup.show_popups boolean
Popups. Allowed values:
popup.is_custom boolean
Popup contents. Allowed values:
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. Allowed values:
popup.font_size number
Font size. Min: 1
popup.fill_color color
Fill colour.
popup.opacity number
Fill opacity. Max: 1
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
Annotations
anno_x_enabled boolean
Show highlights on the x axis.
anno_x_lines text
One per line, in format “Thing :: 2012”.
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 “Thing :: 2013 >> 2015”.
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. Allowed values:
anno_x_label_vertical boolean
Vertical.
anno_x_font_size number
Font size.
anno_x_stack string
Above or below data. Allowed values:
anno_y_enabled boolean
Show highlights on the y axis.
anno_y_lines text
One per line, in format “Thing :: 5000”.
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 “Thing :: 2000 >> 8000”.
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. Allowed values:
anno_y_font_size number
Font size.
anno_y_stack string
Above or below data. Allowed values:
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. Allowed values:
layout.background_image_enabled boolean
Image. Allowed values:
layout.background_color color
Background color.
layout.background_image_src url
Image URL.
layout.background_image_size string
Size. Allowed values:
layout.background_image_position string
Position. Allowed values:
layout.max_width_target string
Maximum width. Apply a maximum width to just the main graphic or everything (main graphic plus header, footer, etc) Allowed values:
layout.max_width number
Maximum width. Leave blank to stretch to container width Min: 50
layout.max_width_align string
Align. Allowed values:
layout.layout_order string
Layout order. Allowed values:
layout.space_between_sections string
Space between sections. Allowed values:
layout.space_between_sections_custom number
Custom. Max: 100
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. Allowed values:
layout.border.top.color color
Color.
layout.border.right.width number
Right.
layout.border.right.style string
Style. Allowed values:
layout.border.right.color color
Color.
layout.border.bottom.width number
Bottom.
layout.border.bottom.style string
Style. Allowed values:
layout.border.bottom.color color
Color.
layout.border.left.width number
Left.
layout.border.left.style string
Style. Allowed values:
layout.border.left.color color
Color.
Header
layout.header_align string
Alignment. Allowed values:
layout.title string
layout.title_styling boolean
Change title styles.
layout.title_font font
Title Font.
layout.title_size string
Size. Allowed values:
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. Allowed values:
layout.title_color color
Color.
layout.title_line_height number
Line height. Max: 3
layout.title_space_above string
Space above. Allowed values:
layout.title_space_above_custom number
Custom. Max: 100
layout.subtitle string
layout.subtitle_styling boolean
Change subtitle styles.
layout.subtitle_font font
Subtitle Font.
layout.subtitle_size string
Size. Allowed values:
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. Allowed values:
layout.subtitle_color color
Color.
layout.subtitle_line_height number
Line height. Max: 3
layout.subtitle_space_above string
Space above. Allowed values:
layout.subtitle_space_above_custom number
Custom. Max: 100
layout.header_text string
layout.header_text_styling boolean
Styling.
layout.header_text_size string
Size. Allowed values:
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. Allowed values:
layout.header_text_color color
Color.
layout.header_text_line_height number
Line height. Max: 3
layout.header_text_space_above string
Space above. Allowed values:
layout.header_text_space_above_custom number
Custom. Max: 100
layout.header_border string
Allowed values:
- top (Top)
- bottom (Bottom)
- none (None)
layout.header_border_width number
Width.
layout.header_border_color color
Color.
layout.header_border_style string
Style. Allowed values:
layout.header_border_space number
Space. Space between border and header text
layout.header_logo_enabled boolean
Allowed values:
- true (Enabled)
- false (Disabled)
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 Allowed values:
layout.header_logo_position_inside string
Position. Allowed values:
layout.header_logo_position_outside string
Position. Allowed values:
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. Allowed values:
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. Allowed values:
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. Allowed values:
layout.footer_align_vertical string
V. align. Allowed values:
layout.footer_border string
Allowed values:
- top (Top)
- bottom (Bottom)
- none (None)
layout.footer_border_width number
Width.
layout.footer_border_color color
Color.
layout.footer_border_style string
Style. Allowed values:
layout.footer_border_space number
Space. Space between border and footer text