Marimekko

Compare categorical variables through columns of changing widths or bars of changing heights

Updated 8 days ago to v5.0.0 by Flourish team

How to use this template

What can this template do?

The Marimekko template allows you to compare categorical variables through columns of changing widths or bars of changing heights depending on the orientation. The bars in this chart can stack, meaning it is possible to compare categories and sub-categories.

How to get started

For the Marimekko template, you’ll need long format data, where each row represents single bar and each column represents a stack in a bar. We recommend that your data has the following layout:

Entity Population Region Low-carbon sources Fossil fuel sources
China 1444216102.00 EAS 7195.87 36222.59
United States 332915074.00 NAC 4654.85 21016.76

These are the bindings of the template:

  • Name: the identifier of each bar. Will appear as a label.
  • Primary metric: the baseline of the chart. The bars cannot be stacked by these values.
  • Secondary metric: represent the stackable value(s). Accepts one or multiple columns. If more that one column are bound, the bars will split into stacks.
  • Grid of charts: splits the chart into smaller subsets based on a categorical column.
  • Color category: a categorical column to color the bars by. If this binding is left blank, then the template will color the bars by stack.
  • Filter by: adds a categorical or a chronological filter to the chart.
  • Info for popups: information to be displayed through popups or panels.

Modes in the Marimekko template

A classic Marimekko chart has both axes set as a percentage. This means, that the bars and stack fill the whole canvas.

A bar mekko chart set the axis containing the secondary metric(s) to show absolute values, not percentages. The result is a chart in which the bars have varying heights depending on the data. You can set whether the secondary axis is treated as a percentage or not in the X axis and Y axis settings through the Treat as a percentage toggle.

Chart set up: orientation and settings

There are two available Orientation modes in the Marimekko template:

  • Vertical mode: the bars grow vertically.
  • Horizonal mode:the bars grow from left to right.

The charts can be sorted by the primary metric, secondary metric or neither.

Color settings

There are three color modes in this template:

  • By stack: this is the default mode. Here the bars are colored by stacks. If there are no stacks, then all the bars will have the same shade.
  • By bar: each bar with a unique name will have a different shade. Stacked bars will color the different segments in the same hue but with a lower opacity.
  • By category: this must be set in the column bindings in the tab. Here, each bar will be colored based on a provided category.

Label settings

Labels can be turned on or off. If they are on, they can be positioned in one of two ways:

  • Edge of chart: labels will be placed on the upper edge of the canvas.

  • Edge of bar: labels will be place atop each bar.

    In the case of overalps, labels can either:

    • Do nothing
    • Hide them: hides overlapping labels.
    • Spread them out: tries to accommodate them in the available space.

Users are also able to add connector lines between the lables and the bars and they can also provide a list of the labels they want to include.

Tips

Credits and feedback

Created by Flourish. Sample data is from Our World in Data showing consumption of different energy types per country and from the International Energy Agency showing marginal abatement costs values. Want to see additional features? Let us know at support@flourish.studio.

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/marimekko

version: 5

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/marimekko",
    version: "5",
    bindings: {
        data: {
            unstacked_value: 1, // 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/marimekko",
    version: "5",
    bindings: {
        data: {
            name: 0, // index of a column in your data
            unstacked_value: 1, // index of a column in your data
            stacked_values: [2, 3, ...], // index(es) of column(s) in your data
            facet: 4, // index of a column in your data
            category: 5, // index of a column in your data
            filter: 6, // index of a column in your data
            metadata: [7, 8, ...], // 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/marimekko",
    version: "5",
    bindings: {
        data: {
            unstacked_value: "DataHeader2",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/marimekko",
    version: "5",
    bindings: {
        data: {
            name: "DataHeader1",
            unstacked_value: "DataHeader2",
            stacked_values: ["DataHeader3", "DataHeader4", ...],
            facet: "DataHeader5",
            category: "DataHeader6",
            filter: "DataHeader7",
            metadata: ["DataHeader8", "DataHeader9", ...],
        }
    },
    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/marimekko",
    version: "5",
    data: {
    data: [
        {
            unstacked_value: ...,
            stacked_values: [...],
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/marimekko",
    version: "5",
    data: {
    data: [
        {
            name: ...,
            unstacked_value: ...,
            stacked_values: [...],
            facet: ...,
            category: ...,
            filter: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

  • data.name: name
  • data.unstacked_value: unstacked_value
  • data.stacked_values: One or more numeric columns. Each column will form a segment of a stacked bar.
  • data.facet: facet
  • data.category: category string
  • data.filter: (Optional) Choose a categorical column to <a href="https://help.flourish.studio/article/573-how-row-and-column-filters-work">filter</a> by. A dropdown will appear in the visualization. string, number, datetime
  • data.metadata: One or more columns of information (text, <a href="https://help.flourish.studio/article/46-how-to-add-images-to-your-visualization">image URLs</a>, <a href="https://help.flourish.studio/article/259-how-to-embed-charts-in-your-popups-or-panels">embedded charts</a> etc) to include in <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups">popups and panels</a> number, string, datetime

Template metadata

Note: metadata is optional, and the API will interpret your data for you if you do not specify it. A typical example of when specifying metadata can be useful is when column(s) in your data contain numbers or dates that you wish to format visually (e.g. to display a column containing MM/DD/YYYY dates in DD/MM/YYYY format).

This template supports an optional metadata property. metadata informs the template what type of data is in each of your columns, and how that data should be formatted visually.

You can specify metadata in one of three formats, depending on the format of opts.data.

1. Array of objects with column indexes as keys

You should supply metadata in this format when opts.data is in the previously described 'array of arrays' format. In this case, metadata should be an object with column index: column type object key/value pairs (column type objects must have type, type_id, and output_format_id keys, documented below):

{
    template: "@flourish/marimekko",
    version: "5",
    ...
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    },
    metadata: {
        data: {
            0: { type: ..., type_id: ..., output_format_id: ... },
            1: { type: ..., type_id: ..., output_format_id: ... },
            2: { type: ..., type_id: ..., output_format_id: ... },
        }
    },
    ...
}

2. Array of objects with column headers as keys

You should supply metadata in this format when opts.data is in the previously described 'array of objects with arbitrary keys' format. In this case, metadata should be an object with column header: column type object key/value pairs (column type objects must have type, type_id, and output_format_id keys, documented below):

{
    template: "@flourish/marimekko",
    version: "5",
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    },
    metadata: {
        data: {
            "DataHeader1": { type: ..., type_id: ..., output_format_id: ... },
            "DataHeader2": { type: ..., type_id: ..., output_format_id: ... },
            "DataHeader3": { type: ..., type_id: ..., output_format_id: ... },
        }
    },
    ...
}

Column type objects:

Column type objects tell the API what type of data is in a column:

{
    type: "number", // options also include 'string', and 'datetime'
    type_id: "number$comma_point", // numbers in the format 13,429.17
    output_format_id: "number$space_comma", // numbers in the format 13 429,17
}

For more information on valid column type values, see Recognized Type Formats.

Template settings

Options for opts.state.

Marimekko

sort_by string

Sort by. Whether your chart is sorted by the primary (unstacked) or the secondary (stacked) metric

Allowed values:

  • none (None)
  • unstacked (Primary metric)
  • stacked (Secondary metric)

sort_direction string

Sort direction.

Allowed values:

  • desc (Descending)
  • asc (Ascending)

orientation string

Orientation.

Allowed values:

  • horizontal (Horizontal)
  • vertical (Vertical)

height_mode string

Height mode. How the graphic's height is determined.

Auto uses the default Flourish responsive sizing.

In Aspect ratio mode, you set the aspect ratio of the plot, and the container will be updated to accommodate it (not supported when embedded in a simple fixed-height iframe).

Allowed values:

  • auto (Auto)
  • aspect_ratio (Aspect ratio)

facet_aspect number

Aspect (desktop). Aspect ratio of each chart in desktop mode, where 1 is square, above 1 is wider, and below 1 is taller

Min: 0.01

facet_aspect_mobile number

Aspect (mobile). Aspect ratio of each chart in mobile mode, where 1 is square, above 1 is wider, and below 1 is taller

Min: 0.01

facet_aspect_breakpoint number

Breakpoint. The width at which mobile mode ends and desktop begins (in px)

stack_padding_stacked number

Space between stacked values. The space between stacked values (in rems)

Max: 0.5

stack_padding_unstacked number

Space between stacks. The space between stacks (in rems).

Max: 0.5

Colors

color_mode string

Color mode. In order to color by stack, you need to have at least two columns bound to the Secondary metric

Allowed values:

  • stack (By stack)
  • bar (By bar)

stack_fade number

Stack fade. How quickly the stacks fade. (Use 1 for no fade)

Min: 0.25

Max: 1

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. Enter the label name for which you wish to set the color, followed by a colon and the desired color value.

Colors can be set using Hex, RGB, color names or RGBA, if you want to set the opacity. Multiple colors can be set using multiple lines. For example:


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

color.numeric_type string

Scale type.

Allowed values:

  • sequential (Sequential)
  • diverging (Diverging)

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.

Allowed values:

  • false (Linear)
  • true (Binned)

color.bin_mode string

Binning mode.

Allowed values:

  • fixed (Fixed width)
  • quantile (Quantile)
  • custom (Custom thresholds)

color.bin_count number

Number of bins.

color.bin_thresholds string

Custom thresholds. Enter your desired thresholds, separating them with a ";". For instance, "5;10;15".

Bins form as follows:

  • From the data's minimum value (domain minimum) up to the first threshold.
  • Between consecutive thresholds.
  • From the last threshold to the data's maximum value (domain maximum).

    • For "5;10;15", you'll get four bins based on your data's range.

      color.sequential_palette string

      Palette.

      Allowed values:

      • Oranges (Oranges)
      • Reds (Reds)
      • Blues (Blues)
      • Greens (Greens)
      • Greys (Greys)
      • Purples (Purples)
      • Viridis (Viridis)
      • Inferno (Inferno)
      • Magma (Magma)
      • Plasma (Plasma)
      • Warm (Warm)
      • Cool (Cool)
      • CubehelixDefault (Cubehelix)
      • BuGn (Blue/Green)
      • BuPu (Blue/Purple)
      • GnBu (Green/Blue)
      • OrRd (Orange/Red)
      • PuBuGn (Purple/Blue/Green)
      • PuBu (Purple/Blue)
      • PuRd (Purple/Red)
      • RdPu (Red/Purple)
      • YlGnBu (Yellow/Blue/Green)
      • YlGn (Yellow/Green)
      • YlOrBr (Yellow/Orange/Brown)
      • YlOrRd (Yellow/Orange/Red)
      • Carrots
      • Custom

      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.

      Allowed values:

      • rgb (RGB)
      • lab (LAB)
      • hcl (HCL)
      • hsl (HSL)

      color.sequential_custom_domain boolean

      Domain.

      Allowed values:

      • false (Auto)
      • true (Custom)

      color.sequential_domain_min number

      Min.

      color.sequential_domain_max number

      Max.

      color.diverging_palette string

      Palette.

      Allowed values:

      • RdBu (Red/Blue)
      • RdYlGn (Red/Yellow/Green)
      • PiYG (Pink/Yellow/Green)
      • BrBG (Brown/Blue/Green)
      • PRGn (Purple/Red/Green)
      • PuOr (Purple/Orange)
      • RdGy (Red/Grey)
      • RdYlBu (Red/Yellow/Blue)
      • Spectral (Spectral)
      • Custom

      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.

      Allowed values:

      • rgb (RGB)
      • lab (LAB)
      • hcl (HCL)
      • hsl (HSL)

      color.diverging_custom_domain boolean

      Domain.

      Allowed values:

      • false (Auto)
      • true (Custom)

      color.diverging_domain_min number

      Min.

      color.diverging_domain_mid number

      Mid.

      color.diverging_domain_max number

      Max.

      Labels

      enable_labels string

      Show labels. Auto turns labels off if there are more than 50

      Allowed values:

      • auto (Auto)
      • on (On)
      • off (Off)

      label_position string

      Label position. This alters the position of the label from being at the edge of the chart to the edge of the bars.

      Note these two positions will only be different when the secondary measure is not being treated as a percentage

      Allowed values:

      • edge_of_chart (Edge of chart)
      • edge_of_bar (Edge of bar)

      labels.max_width number

      Max label width. The maximum allowed label width

      labels.overlap_mode string

      Overlaps. What to do with overlaps

      Allowed values:

      • spread (Spread them out)
      • hide (Hide them)
      • none (Do nothing)

      labels.spreading_margin number

      Space between labels. The space left between labels when spreading them out to avoid overlaps

      labels.data_point_margin number

      Distance. The space between the data point and the label in rems (a multiple of base font size)

      labels.show_only_labels text

      Show only certain labels. Manually specify which labels you'd like to display (one entry per line)

      labels.text_color color

      Color.

      labels.text_size number

      Size.

      Max: 100

      labels.text_bg_color color

      Outline.

      labels.text_bg_size number

      Outline width. As a % of the font size

      Max: 100

      labels.text_line_height number

      Line height.

      labels.text_max_lines number

      Max lines. The max number of lines for each label

      labels.text_weight string

      Weight.

      Predefined values:

      • 400 (Normal)
      • 700 (Bold)

      labels.lines string

      Connector lines.

      Allowed values:

      • auto (Auto)
      • on (On)
      • off (Off)

      labels.line_style string

      Line style.

      Allowed values:

      • straight (Straight)
      • step (Step)

      labels.line_color color

      Color.

      labels.line_width number

      Width. In rems (a multiple of base font size)

      Max: 0.5

      labels.line_range number

      Length. The width of the space given over to lines; in rems, a multiple of base font size

      labels.line_padding number

      Padding. The padding to the left and right of the line; in rems, a multiple of base font size

      Grid of charts

      facets.columns_fixed boolean

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

      Allowed values:

      • false (Auto)
      • true (Fixed)

      facets.columns number

      Columns. The number of columns in the grid. (If specifying custom positions, extra columns may be added automatically.)

      Min: 1

      facets.min_width number

      Min chart width. The minimum width of a chart or cell in the grid. Determines the number of columns.

      facets.min_width_fixed number

      Min chart width. Specify the minimum width of a chart or cell in the grid, below which the Fixed grid will be ignored and it will fall back to responsive Auto mode.

      facets.custom_grid boolean

      Add custom positions. Specify positions for individual charts in the grid – useful for making a map layout

      facets.custom_positions text

      Custom positions. Enter the name of a facet, one per line, using the format:

      Facet name: row, column
      where row and column are numbers indicating the grid position where a facet should be positioned.

      For example,
      Alaska : 1, 1
      Maine : 1, 11
      Wisconsin : 2, 6

      Min: 1

      facets.max_width number

      Max chart width. The maximum width of a chart or cell in the grid

      facets.gutter_w number

      Horizontal margin.

      facets.gutter_h number

      Vertical margin.

      facets.animation string

      On data change. If a chart in the grid is removed, that cell can either be animated out (with another cell moving to take its place) or reused for the new data in that cell. Auto decides for you based on the data.

      Allowed values:

      • auto (Auto)
      • name (Remove)
      • reuse (Reuse)

      facets.titles boolean

      Show titles.

      facets.title_align string

      Alignment.

      Allowed values:

      • auto (Auto)
      • left (fa-align-left)
      • center (fa-align-center)
      • right (fa-align-right)

      facets.title_size number

      Size. Relative to the width of the chart

      facets.title_unit string

      Scale with chart.

      Allowed values:

      • rem (Off)
      • facet (On)

      facets.title_color color

      Color.

      facets.title_padding_top number

      Space above.

      facets.title_padding_bottom number

      Space below.

      facets.title_bg string

      Background.

      Allowed values:

      • none (None)
      • full (Full)
      • text (Text)

      facets.title_bg_color color

      Background color.

      facets.title_bg_padding number

      Background padding. Horizontal space between text and background

      X axis

      x_as_percentage boolean

      Treat as percentage. Displays values summed to 100%. This is useful for comparing proportional contributions across all categories.

      matching_x_axis boolean

      Match x axes accross facets.

      x.axis_position string

      Allowed values:

      • bottom (Axis visible)
      • off (Axis hidden)

      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:

      • linear (Linear)
      • log (Log)

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

      Flip axis.

      x.show_scale_settings boolean

      Configure default min/max.

      x.nice boolean

      Round min/max. Enabling this option rounds the X axis start and end values to <a href="https://help.flourish.studio/article/224-how-to-avoid-gaps-between-axes-and-series>tidy numbers, such as 0, 50, 100 or whole years. Specified min and max values will override this feature.

      Allowed values:

      • true (On)
      • false (Off)

      x.zero_axis string

      Include zero. Enable to extend the axis to include zero, even when data is all positive or all negative. This is ignored if you set specific min and max scale values.

      Allowed values:

      • auto (Auto)
      • on (On)
      • off (Off)

      x.title_mode string

      Type.

      Allowed values:

      • auto (Auto)
      • custom (Custom)

      x.title string

      Text.

      x.title_styling boolean

      Styling.

      x.title_weight string

      Weight.

      Allowed values:

      • bold (Bold)
      • normal (Regular)

      x.title_color color

      Color.

      x.title_size number

      Size.

      x.title_padding number

      Padding.

      x.tick_label_position string

      Position.

      Allowed values:

      • default (Default)
      • left (Left)
      • right (Right)

      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:

      • 0 (0°)
      • 30 (30°)
      • 45 (45°)
      • 60 (60°)
      • 90 (90°)

      x.tick_label_weight string

      Weight.

      Allowed values:

      • bold (Bold)
      • normal (Regular)

      x.tick_label_max_lines number

      Max lines.

      Min: 1

      x.tick_label_line_height number

      Line height.

      x.tick_label_space_mode string

      Space mode.

      Allowed values:

      • auto (Auto)
      • max (Max)
      • fixed (Fixed)

      x.tick_label_space number

      Space.

      x.tick_mode string

      Mode. Sets the method for selecting tick values on the axis:

      Auto automatically selects the ticks
      Number allows you to choose the number of ticks to display.
      Custom lets you select specific ticks to show.

      Note: If the axis is categorical, Number mode is ignored.

      Allowed values:

      • auto (Auto)
      • number (Number)
      • custom (Custom)

      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. For dates, use the input format as specified in the datasheet.

      You can also use {{FIRST}} and {{LAST}} to add ticks at the minimum and maximum of the axis. For example:

      {{FIRST}}
      25000
      50000
      75000
      {{LAST}}

      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:

      • out (Out)
      • in (In)

      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

      Max: 100

      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:

      • solid (Solid)
      • dash (Dashed)
      • dot (Dotted)
      • dot_dash (Dot-dashed)

      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.

      x.gridline_category_dividers_extend boolean

      Extend. Extends the dividers into the axis margins.

      x_formatting.prefix string

      Prefix. Text to place in front of a number

      x_formatting.suffix string

      Suffix. Text to place after a number

      x_formatting.n_dec number

      Decimal places. Decimal places. You can also enter a negative integer to round to a whole number with that many zeros. For example, -2 will round to the nearest hundred.

      Min: -10

      Max: 10

      x_formatting.advanced boolean

      Advanced.

      x_formatting.negative_sign string

      Styling of negative numbers.

      Allowed values:

      • -$nk (-$100k)
      • $-nk ($-100k)
      • ($nk) (($100k))
      • $(n)k ($(100)k)
      • none ($100k)

      x_formatting.strip_zeros boolean

      Remove trailing zeros.

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

      x_formatting.transform_labels boolean

      Multiply/divide values.

      x_formatting.transform string

      Allowed values:

      • multiply (Multiply by)
      • divide (Divide by)
      • exponentiate (×10 to the power of)

      x_formatting.multiply_divide_constant number

      x_formatting.exponentiate_constant number

      Y axis

      y_as_percentage boolean

      Treat as percentage. Displays values summed to 100%. This is useful for comparing proportional contributions across all categories.

      matching_y_axis boolean

      Match y axes accross facets.

      y.axis_visible boolean

      Allowed values:

      • true (Axis visible)
      • false (Axis hidden)

      y.numeric_scale_type string

      Type.

      Allowed values:

      • linear (Linear)
      • log (Log)

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

      Flip axis.

      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.

      Allowed values:

      • true (On)
      • false (Off)

      y.zero_axis string

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

      Allowed values:

      • auto (Auto)
      • on (On)
      • off (Off)

      y.title_mode string

      Type.

      Allowed values:

      • auto (Auto)
      • custom (Custom)

      y.title string

      Text.

      y.title_styling boolean

      Styling.

      y.title_position string

      Position.

      Allowed values:

      • side (Side)
      • end (Top/bottom)

      y.title_weight string

      Weight.

      Allowed values:

      • bold (Bold)
      • normal (Regular)

      y.title_color color

      Color.

      y.title_size number

      Size.

      y.title_padding number

      Padding.

      y.tick_label_position string

      Position.

      Allowed values:

      • default (Default)
      • above (Above)
      • below (Below)

      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:

      • 0 (0°)
      • 30 (30°)
      • 45 (45°)
      • 60 (60°)
      • 90 (90°)

      y.tick_label_weight string

      Weight.

      Allowed values:

      • bold (Bold)
      • normal (Regular)

      y.tick_label_max_lines number

      Max lines.

      Min: 1

      y.tick_label_line_height number

      Line height.

      y.tick_label_space_mode string

      Space mode.

      Allowed values:

      • auto (Auto)
      • max (Max)
      • fixed (Fixed)

      y.tick_label_space number

      Space.

      y.tick_mode string

      Mode. Sets the method for selecting tick values on the axis:

      Auto automatically selects the ticks
      Number allows you to choose the number of ticks to display.
      Custom lets you select specific ticks to show.

      Note: If the axis is categorical, Number mode is ignored.

      Allowed values:

      • auto (Auto)
      • number (Number)
      • custom (Custom)

      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. For dates, use the input format as specified in the datasheet.

      You can also use {{FIRST}} and {{LAST}} to add ticks at the minimum and maximum of the axis. For example:

      {{FIRST}}
      25000
      50000
      75000
      {{LAST}}

      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:

      • out (Out)
      • in (In)

      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

      Max: 100

      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:

      • solid (Solid)
      • dash (Dashed)
      • dot (Dotted)
      • dot_dash (Dot-dashed)

      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_formatting.prefix string

      Prefix. Text to place in front of a number

      y_formatting.suffix string

      Suffix. Text to place after a number

      y_formatting.n_dec number

      Decimal places. Decimal places. You can also enter a negative integer to round to a whole number with that many zeros. For example, -2 will round to the nearest hundred.

      Min: -10

      Max: 10

      y_formatting.advanced boolean

      Advanced.

      y_formatting.negative_sign string

      Styling of negative numbers.

      Allowed values:

      • -$nk (-$100k)
      • $-nk ($-100k)
      • ($nk) (($100k))
      • $(n)k ($(100)k)
      • none ($100k)

      y_formatting.strip_zeros boolean

      Remove trailing zeros.

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

      y_formatting.transform_labels boolean

      Multiply/divide values.

      y_formatting.transform string

      Allowed values:

      • multiply (Multiply by)
      • divide (Divide by)
      • exponentiate (×10 to the power of)

      y_formatting.multiply_divide_constant number

      y_formatting.exponentiate_constant number

      Controls

      filter_control.control_type string

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

      Allowed values:

      • dropdown (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAC0AAAAKCAYAAAFXtOeCAAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAALaADAAQAAAABAAAACgAAAAAWgdR+AAAAtklEQVQ4EdVV3QnEIAw25TbSB2foNI7iMu0MbuUR4ZOQy4OFCL2AmN8vMQallNLVez+DosNSsg/FGLtyDkR0H1rJMqOMiJxz4KWp1jpUsLNsptCBkD/MlFIgzx3IsD9GflTGTLvImN1ajP1x043dVrlr1fIY4xZZYd2kdATfWgu8NCEedtdWcJ+R1BVYnmIbsEzizW8bDO9CJd4cOijxCEH22DGIq1iyBiv2P8eDP4jVDrzE7/oCOyRFCckULykAAAAASUVORK5CYII=)
      • buttons (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAAKCAYAAAFaqpfFAAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAK6ADAAQAAAABAAAACgAAAACxtWN2AAAA5klEQVQ4EdVUwQ2DMAwkqBuFBzO0y2QUlqEz5AEzpTrUiyzLEEPbRy2F2D7n4tgWYRiGuZRy75T0lhMxIcZYoKzrWvUeDi0VTSlt2DRN9dQ4jh0WBP4avHneH3kF/SGE5w0GWXPOHRaFfrDiEW5mEJjBZJY7UoPNakjM0s0KWYFnfa6MUbRlWR573daXurLlhHDXJNreugan7D2D0K09YUeJy467no+D1iyRUO+u5+tDLdudaYuIOEcQtncMeba1/6QCrUuv4nWwJIE1ZBKHLgdJY0f2J9z/NQb4cRxV4iQ2y/hvc78ACNVvxtjAMtcAAAAASUVORK5CYII=)
      • slider (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACkAAAAKCAYAAAFeX0f4AAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAKaADAAQAAAABAAAACgAAAABlifOxAAABz0lEQVQ4Ea1UvU7CUBSml05EHoBEB3gFGpg0fQE0Tk6suDC4uKBuxsXJ6BswGZaq0bnRqaR9CglPwEJCW79Dem5Of2iq8Sbk/H/349zTU7Msy6nhdLvdJUk+Ko7jk8RosbNcAupKZhjAjMkRBIHWG41GbTQayTzSP1IOIL32er3DlDMxTEI1DGPh+/4BSA7CMBxMp9N8LlAu2EtF+IVsS6m5maZpeZ4XcDApUGzX6/Wj+Xz+xXaZ1EWg59m2vSeSdYx8URRdili52u/394syqFlgu6TGFcV3+dRms/lGoS8TCAysP+FrUYN39U3WsG4mCmq2b3+Kt3cA9swJiVR4se1sZPw5kwEp8EBgpOD5fWJGOp/hcGiwXiap+atOp2MCTI8HZukY/ogLcUFqlNlfJHl8Vii6abfbj7PZrHDOuBiPNAH7W9hZxhFhgMwd5/6XZJIaDxeFIPHUbDavXddd6QAUmqJse2WcdNS/JV3Lhv5s50gyEi5bQB/jwhf2YcBoYZXuph3LhiF+LcHjXQ4kAQTYGudya0hUbIwzTL8LX+qjFznRer22MbyVtoqoK1UNPKGDy8cgRp2rdOi7p22Ep7eoAP/WV0rdV115lS4RST+YjrA2q0ehBQAAAABJRU5ErkJggg==)

      filter_control.control_styles boolean

      Adv..

      filter_control.control_title string

      Control title.

      filter_control.button_group boolean

      Grouped.

      Allowed values:

      • true (On)
      • false (Off)

      filter_control.button_group_width_mode string

      Button group width.

      Allowed values:

      • auto (Auto)
      • full (Full)
      • fixed (Fixed)

      filter_control.button_group_width_fixed number

      Width.

      Max: 100

      filter_control.dropdown_width_mode string

      Dropdown width.

      Allowed values:

      • auto (Auto)
      • full (Full)
      • fixed (Fixed)

      filter_control.dropdown_width_fixed number

      Width.

      Max: 100

      filter_control.slider_width number

      Slider width. Width of the slider track in rems

      Max: 100

      filter_control.slider_max_label_width number

      Max label width. In rems, multiples of base font size. If larger than the longest label, only the space required to fit labels will be used.

      Max: 100

      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.

      Min: -100

      Max: 100

      filter_control.slider_loop boolean

      Loop.

      filter_control.slider_restart_pause number

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

      Max: 100

      filter_control.sort boolean

      Sorting.

      Allowed values:

      • true (On)
      • false (Off)

      filter_show_all boolean

      Include "All".

      filter_show_all_text string

      Name for "All". Leave blank to not include an All option

      controls_container.alignment string

      Alignment.

      Allowed values:

      • start (fa-align-left)
      • center (fa-align-center)
      • end (fa-align-right)

      controls_container.controls_spacing number

      Spacing. The space between controls, like dropdowns and adjacent button sets, in em units.

      Max: 5

      controls_style.font_size number

      Text size.

      Max: 5

      controls_style.font_weight string

      Text weight.

      Allowed values:

      • bold (Bold)
      • normal (Normal)

      controls_style.height number

      Height.

      Max: 5

      Background.

      Text color.

      Dropdown border styles.

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

      Allowed values:

      • all (All sides)
      • bottom (Bottom)

      Border width.

      Max: 20

      Color.

      Transparency.

      Max: 1

      Radius.

      Max: 100

      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.

      Max: 20

      button_style.border_color color

      Color.

      button_style.border_transparency number

      Transparency.

      Max: 1

      button_style.border_radius number

      Radius.

      Max: 100

      Legend

      legend_categorical.show_legend boolean

      Legend mode. A legend will not show with a single entry

      Allowed values:

      • true (Enabled)
      • false (Disabled)

      legend_categorical.title_mode string

      Title mode.

      Allowed values:

      • auto (Auto)
      • custom (Custom)

      legend_categorical.title string

      Title.

      legend_categorical.swatch_width number

      Width.

      legend_categorical.swatch_height number

      Height.

      legend_categorical.swatch_radius number

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

      legend_categorical.legend_items_padding number

      Padding. Padding between legend items (in rems)

      legend_categorical.swatch_outline boolean

      Outline. An optional outline for the swatch in the legend

      legend_categorical.swatch_outline_color color

      Color.

      legend_categorical.order_override text

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

      legend_categorical.icon_height number

      Height. Height of icon (in rems)

      legend_categorical.icon_color color

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

      legend_categorical.max_width number

      Max width.

      legend_categorical.orientation string

      Orientation.

      Allowed values:

      • horizontal (Horizontal)
      • vertical (Vertical)

      legend_container.alignment string

      Alignment.

      Allowed values:

      • start (fa-align-left)
      • center (fa-align-center)
      • end (fa-align-right)

      legend_container.orientation string

      Orientation.

      Allowed values:

      • horizontal (Horizontal)
      • vertical (Vertical)

      legend_container.title_weight string

      Title weight.

      Allowed values:

      • bold (Bold)
      • normal (Normal)

      legend_container.text_weight string

      Text weight.

      Allowed values:

      • bold (Bold)
      • normal (Normal)

      legend_container.text_color color

      Color.

      legend_container.text_size number

      Size.

      Max: 10

      Popups & panels

      popup.mode string

      Allowed values:

      • none (None)
      • popup (Popup)
      • panel (Panel)
      • both (Both)

      popup.popup_is_custom boolean

      Popup content.

      Allowed values:

      • false (Auto)
      • true (Custom)

      popup.show_popup_styles boolean

      Show popup styles.

      popup.popup_custom_header html

      Popup custom header. Use {{column_name}} to add a value from your data. Ensure the column is selected, or add it to Info for popups for popup use.

      Advanced users can add HTML styling or add category colors to popup headers.

      To hide parts of the popup when a column is empty using

      {{#if column_name}}Content for non-empty column_name{{/if}}.
      For example:
      {{#if Capital name}}Capital:{{/if}} {{Capital name}}.
      Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.

      popup.popup_custom_main html

      Popup custom main content. Use {{column_name}} to add a value from your data. Ensure the column is selected, or add it to Info for popups for popup use.

      Advanced users can add HTML for designs, styles, and images.

      To hide parts of the popup when a column is empty use the syntax

      {{#if column_name}}Content for non-empty column_name{{/if}}.
      For example:
      {{#if Capital name}}Capital:{{/if}} {{Capital name}}.
      Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.

      popup.popup_custom_accessible text

      Popup custom accessible content. A text alternative to visual custom popup content that will be read out by screenreaders. This content is added as an aria-label attribute to data point elements. You can still use {{column_name}} to add values from your data, but do not use HTML. For example: {Name}}, Population: {{Population}}, GDP: {{GDP}} If left empty, accessible content will fallback to the default popup content.

      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.

      Allowed values:

      • start (fa-align-left)
      • center (fa-align-center)
      • end (fa-align-right)

      popup.popup_background color

      Fill color.

      popup.popup_background_opacity number

      Fill opacity.

      Max: 1

      popup.popup_padding number

      Padding.

      popup.popup_radius number

      Radius. Corner radius of popup

      popup.popup_header_type string

      Header style.

      Allowed values:

      • block (Header block)
      • inline (Header inline)

      popup.popup_header_background color

      Background.

      popup.popup_header_text_color color

      Text.

      popup.popup_list_type string

      List type.

      Allowed values:

      • table (fa-table)
      • ul (fa-list)

      popup.popup_list_label_weight string

      Label weight.

      Allowed values:

      • normal (Normal)
      • bold (Bold)

      popup.popup_list_separator string

      List separator.

      Predefined values:

      • : (:)
      • (–)
      • (Empty space)
      • <br /> (Line break)

      popup.popup_shadow boolean

      Shadow.

      popup.popup_pointer boolean

      Pointer.

      popup.panel_position string

      Allowed values:

      • overlay (Overlay)
      • left (Left)
      • right (Right)
      • top (Top)
      • bottom (Bottom)

      popup.panel_open_duration number

      Open duration.

      Max: 2000

      popup.panel_side_fixed boolean

      Always show.

      popup.panel_side_default_content text

      Placeholder content.

      popup.panel_is_custom boolean

      Panel content.

      Allowed values:

      • false (Auto)
      • true (Custom)

      popup.show_panel_styles boolean

      Show panel styles.

      popup.panel_custom_header html

      Panel custom header. Use {{column_name}} to add a value from your data. Ensure the column is selected, or add it to Info for popups for panel use.

      Advanced users can add HTML for styling or add category colors to panel headers.

      To hide parts of the panel when a column is empty using

      {{#if column_name}}Content for non-empty column_name{{/if}}.
      For example:
      {{#if Capital name}}Capital:{{/if}} {{Capital name}}.
      Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.

      popup.panel_custom_main html

      Panel custom main content. Use {{column_name}} to add a value from your data. Ensure the column is selected, or add it to Info for popups for panel use.

      Advanced users can add HTML for designs, styles, images, videos and embedded Flourish charts,

      To hide parts of the panel when a column is empty using

      {{#if column_name}}Content for non-empty column_name{{/if}}.
      For example:
      {{#if Capital name}}Capital:{{/if}} {{Capital name}}.
      Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.

      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 visualization is really tall, this will make sure the panel content is always on top of the element you've clicked on

      Allowed values:

      • click (Click position)
      • center (Center)

      popup.panel_text_color color

      Text color.

      popup.panel_font_size number

      Text size.

      popup.panel_align string

      Alignment.

      Allowed values:

      • start (fa-align-left)
      • center (fa-align-center)
      • end (fa-align-right)

      popup.panel_background color

      Fill color.

      popup.panel_background_opacity number

      Fill opacity.

      Max: 1

      popup.panel_padding number

      Padding.

      popup.panel_radius number

      Radius. Corner radius of panel

      popup.panel_list_type string

      List type.

      Allowed values:

      • table (fa-table)
      • ul (fa-list)

      popup.panel_list_label_weight string

      Label weight.

      Allowed values:

      • normal (Normal)
      • bold (Bold)

      popup.panel_list_separator string

      List separator.

      Predefined values:

      • : (:)
      • (–)
      • (Empty space)
      • <br /> (Line break)

      popup.panel_shadow boolean

      Shadow.

      Annotations

      axes_highlights.x_enabled boolean

      Show highlights on the x axis.

      axes_highlights.x_lines text

      One per line, in format “My label :: 2012”. One per line, using the format:

       My label :: 2012 
      For dates, use the input format as specified in the datasheet. You can optionally specify a line color and a text color. For visualizations using a grid of charts, you can apply the annotation only on a specific chart. Use the format:
       My label :: 2012 :: line_color / text_color :: facet_name 
      For example,
       My label :: 2012 :: #eb0000 / #0084bd :: Category 1
      If you want to add an annotation to just one specific chart but do not want to color the line/text, you can leave that part blank. For example:
       My label :: 2012 ::  :: Category 1 

      axes_highlights.x_line_color color

      Line color.

      axes_highlights.x_line_width number

      Line width.

      axes_highlights.x_line_dash number

      Dash.

      axes_highlights.x_areas text

      One per line, in format “My label :: 2013 >> 2015”. One per line, using the format:

       My label :: date >> date 
      For dates, use the input format as specified in the datasheet. You can optionally specify a line color and a text color. For visualizations using a grid of charts, you can apply the annotation only on a specific chart. Use the format:
       My label :: 2012 :: area_color / text_color :: facet_name
      For example,
       My label :: 2012 >> 2015 :: #eb0000 / #0084bd :: Category 1 

      axes_highlights.x_area_color color

      Area.

      axes_highlights.x_area_opacity number

      Area opacity.

      axes_highlights.x_area_texture string

      Area texture.

      Allowed values:

      • none (fa-stop)
      • fl-pattern-diagonal (fa-bars)
      • fl-pattern-grid (fa-th)
      • fl-pattern-dots (fa-circle-o)

      axes_highlights.x_label_vertical boolean

      Vertical.

      axes_highlights.x_label_y_position string

      Y position. Vertically position the label at the top, bottom or in the middle of the line. This setting will be ignored if there is not enough space for the selected position

      Allowed values:

      • bottom (fa-arrow-down)
      • middle (fa-minus)
      • top (fa-arrow-up)

      axes_highlights.x_label_x_position string

      X position. Horizontally position the label on the left, the right or in the middle of the line. This setting will be ignored if there is not enough space for the selected position

      Allowed values:

      • left (fa-arrow-left)
      • middle (fa-minus)
      • right (fa-arrow-right)

      axes_highlights.x_label_max_width number

      Max width.

      Min: 1

      axes_highlights.x_font_size number

      Font size.

      axes_highlights.x_font_weight string

      Font weight.

      Allowed values:

      • regular (Regular)
      • bold (Bold)

      axes_highlights.x_label_color color

      Text.

      axes_highlights.x_shadow_color color

      Shadow.

      axes_highlights.x_shadow_enabled boolean

      Shadow.

      axes_highlights.y_enabled boolean

      Show highlights on the y axis.

      axes_highlights.y_lines text

      One per line, in format “My label :: 5000”. One per line, using the format:

       My label :: 2012 
      For dates, use the input format as specified in the datasheet. You can optionally specify a line color and a text color. For visualizations using a grid of charts, you can apply the annotation only on a specific chart. Use the format:
       My label :: 2012 :: line_color / text_color :: facet_name 
      For example:
       My label :: 2012 :: #eb0000 / #0084bd :: Category 1 
      If you want to add an annotation to just one specific chart but do not want to color the line/text, you can leave that part blank. For example:
       My label :: 2012 ::  :: Category 1 

      axes_highlights.y_line_color color

      Line color.

      axes_highlights.y_line_width number

      line width.

      axes_highlights.y_line_dash number

      Dash.

      axes_highlights.y_areas text

      One per line, in format “My label :: 2000 >> 8000”. One per line, using the format:

       My label :: date >> date 
      For dates, use the input format as specified in the datasheet. You can optionally specify a line color and a text color. For visualizations using a grid of charts, you can apply the annotation only on a specific chart. Use the format:
       My label :: 2012 :: area_color / text_color :: facet_name 
      For example:
       My label :: 2012 >> 2015 :: #eb0000 / #0084bd :: Category 1 

      axes_highlights.y_area_color color

      Area.

      axes_highlights.y_area_opacity number

      Area opacity.

      axes_highlights.y_area_texture string

      Area texture.

      Allowed values:

      • none (fa-stop)
      • fl-pattern-diagonal (fa-bars)
      • fl-pattern-grid (fa-th)
      • fl-pattern-dots (fa-circle-o)

      axes_highlights.y_label_x_position string

      X position. Horizontally position label on the left, the middle or the right end of the line. This setting will be ignored if there is not enough space for the selected position

      Allowed values:

      • left (fa-arrow-left)
      • middle (fa-minus)
      • right (fa-arrow-right)

      axes_highlights.y_label_y_position string

      Y position. Vertically position the label above, below or in the middle of the line. This setting will be ignored if there is not enough space for the selected position

      Allowed values:

      • above (fa-arrow-up)
      • middle (fa-minus)
      • below (fa-arrow-down)

      axes_highlights.y_label_max_width number

      Max width.

      Min: 1

      axes_highlights.y_font_size number

      Font size.

      axes_highlights.y_font_weight string

      Font weight.

      Allowed values:

      • regular (Regular)
      • bold (Bold)

      axes_highlights.y_label_color color

      Text.

      axes_highlights.y_shadow_color color

      Shadow.

      axes_highlights.y_shadow_enabled boolean

      Shadow.

      axes_highlights_stack_order string

      Stack order. Whether your axis highlights should be displayed above or below your chart area

      Allowed values:

      • above_data (Above data)
      • below_data (Below data)

      annotations_styles boolean

      Show styling options.

      annotations.defaults.text_weight string

      Weight.

      Allowed values:

      • normal (data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iN3B4IiBoZWlnaHQ9IjMwcHgiIHZpZXdCb3g9IjAgMCA3IDMwIiB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPgogICAgPCEtLSBHZW5lcmF0b3I6IFNrZXRjaCA2My4xICg5MjQ1MikgLSBodHRwczovL3NrZXRjaC5jb20gLS0+CiAgICA8dGl0bGU+bm9ybWFsPC90aXRsZT4KICAgIDxkZXNjPkNyZWF0ZWQgd2l0aCBTa2V0Y2guPC9kZXNjPgogICAgPGcgaWQ9Im5vcm1hbCIgc3Ryb2tlPSJub25lIiBzdHJva2Utd2lkdGg9IjEiIGZpbGw9Im5vbmUiIGZpbGwtcnVsZT0iZXZlbm9kZCI+CiAgICAgICAgPHBhdGggZD0iTTEuMTA1OTQ3OTYsMTkgTDEuOTI1NjUwNTYsMTYuNTYwOTc1NiBMNS4wMzUzMTU5OSwxNi41NjA5NzU2IEw1Ljg0MjAwNzQzLDE5IEw3LDE5IEw0LjExMTUyNDE2LDExIEwyLjg4ODQ3NTg0LDExIEwwLDE5IEwxLjEwNTk0Nzk2LDE5IFogTTQuNzYyMDgxNzgsMTUuNzQzOTAyNCBMMi4xOTg4ODQ3NiwxNS43NDM5MDI0IEwyLjYwMjIzMDQ4LDE0LjUyNDM5MDIgQzIuNzU4MzY0MzEsMTQuMDc3MjM1OCAyLjkwNTgyNDA0LDEzLjYzMjExMzggMy4wNDQ2MDk2NywxMy4xODkwMjQ0IEMzLjE4MzM5NTI5LDEyLjc0NTkzNSAzLjMxNzg0Mzg3LDEyLjI5MjY4MjkgMy40NDc5NTUzOSwxMS44MjkyNjgzIEwzLjQ0Nzk1NTM5LDExLjgyOTI2ODMgTDMuNSwxMS44MjkyNjgzIEMzLjYzODc4NTYzLDEyLjI5MjY4MjkgMy43Nzc1NzEyNSwxMi43NDU5MzUgMy45MTYzNTY4OCwxMy4xODkwMjQ0IEM0LjA1NTE0MjUsMTMuNjMyMTEzOCA0LjIwMjYwMjIzLDE0LjA3NzIzNTggNC4zNTg3MzYwNiwxNC41MjQzOTAyIEw0LjM1ODczNjA2LDE0LjUyNDM5MDIgTDQuNzYyMDgxNzgsMTUuNzQzOTAyNCBaIiBpZD0iQSIgZmlsbD0iIzMzMzMzMyIgZmlsbC1ydWxlPSJub256ZXJvIj48L3BhdGg+CiAgICA8L2c+Cjwvc3ZnPg==)
      • bold (data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iOHB4IiBoZWlnaHQ9IjMwcHgiIHZpZXdCb3g9IjAgMCA4IDMwIiB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPgogICAgPCEtLSBHZW5lcmF0b3I6IFNrZXRjaCA2My4xICg5MjQ1MikgLSBodHRwczovL3NrZXRjaC5jb20gLS0+CiAgICA8dGl0bGU+Ym9sZDwvdGl0bGU+CiAgICA8ZGVzYz5DcmVhdGVkIHdpdGggU2tldGNoLjwvZGVzYz4KICAgIDxnIGlkPSJib2xkIiBzdHJva2U9Im5vbmUiIHN0cm9rZS13aWR0aD0iMSIgZmlsbD0ibm9uZSIgZmlsbC1ydWxlPSJldmVub2RkIj4KICAgICAgICA8cGF0aCBkPSJNMi4zMzExMjU4MywxOSBMMi43NTQ5NjY4OSwxNy4wODkyMzA4IEw1LjE2NTU2MjkxLDE3LjA4OTIzMDggTDUuNTg5NDAzOTcsMTkgTDgsMTkgTDUuMzc3NDgzNDQsMTAgTDIuNjIyNTE2NTYsMTAgTDAsMTkgTDIuMzMxMTI1ODMsMTkgWiBNNC43NTQ5NjY4OSwxNS4yNDc2OTIzIEwzLjE2NTU2MjkxLDE1LjI0NzY5MjMgTDMuMzExMjU4MjgsMTQuNjI0NjE1NCBDMy40MTcyMTg1NCwxNC4xOTA3NjkyIDMuNTIwOTcxMywxMy43MjIzMDc3IDMuNjIyNTE2NTYsMTMuMjE5MjMwOCBDMy43MjQwNjE4MSwxMi43MTYxNTM4IDMuODIzMzk5NTYsMTIuMjMzODQ2MiAzLjkyMDUyOTgsMTEuNzcyMzA3NyBMMy45MjA1Mjk4LDExLjc3MjMwNzcgTDMuOTczNTA5OTMsMTEuNzcyMzA3NyBDNC4wNzk0NzAyLDEyLjIyNDYxNTQgNC4xODU0MzA0NiwxMi43MDQ2MTU0IDQuMjkxMzkwNzMsMTMuMjEyMzA3NyBDNC4zOTczNTA5OSwxMy43MiA0LjUwMzMxMTI2LDE0LjE5MDc2OTIgNC42MDkyNzE1MiwxNC42MjQ2MTU0IEw0LjYwOTI3MTUyLDE0LjYyNDYxNTQgTDQuNzU0OTY2ODksMTUuMjQ3NjkyMyBaIiBpZD0iQSIgZmlsbD0iIzMzMzMzMyIgZmlsbC1ydWxlPSJub256ZXJvIj48L3BhdGg+CiAgICA8L2c+Cjwvc3ZnPg==)

      annotations.defaults.text_size number

      Text size.

      annotations.defaults.text_color color

      Text color.

      annotations.defaults.label_width number

      Max width.

      Min: 2

      Max: 20

      annotations.defaults.text_background_mode string

      Text background.

      Allowed values:

      • none (None)
      • outline (Outline)
      • background (Background)

      annotations.defaults.text_bg color

      Outline.

      annotations.defaults.label_bg color

      Background.

      annotations.defaults.text_alignment string

      Alignment.

      Allowed values:

      • auto (Auto)
      • start (Left)
      • center (Center)
      • end (Right)

      annotations.defaults.popup_position string

      Popup position.

      Allowed values:

      • center (Center)
      • left (Left)
      • right (Right)
      • top (Top)
      • bottom (Bottom)

      annotations.defaults.line_marker string

      Marker.

      Allowed values:

      • none (None)
      • arrowhead_open (data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjwhRE9DVFlQRSBzdmcgUFVCTElDICItLy9XM0MvL0RURCBTVkcgMS4xLy9FTiIgImh0dHA6Ly93d3cudzMub3JnL0dyYXBoaWNzL1NWRy8xLjEvRFREL3N2ZzExLmR0ZCI+Cjxzdmcgd2lkdGg9IjEycHgiIGhlaWdodD0iMzFweCIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4bWw6c3BhY2U9InByZXNlcnZlIiB4bWxuczpzZXJpZj0iaHR0cDovL3d3dy5zZXJpZi5jb20vIiBzdHlsZT0iZmlsbC1ydWxlOmV2ZW5vZGQ7Y2xpcC1ydWxlOmV2ZW5vZGQ7c3Ryb2tlLWxpbmVjYXA6c3F1YXJlOyI+CiAgICA8ZyB0cmFuc2Zvcm09Im1hdHJpeCgxLDAsMCwxLC0wLjA3MTYsMC4wMDY2NzYzNSkiPgogICAgICAgIDxnPgogICAgICAgICAgICA8cmVjdCBpZD0iQXJ0Ym9hcmQyIiB4PSIwLjA3MiIgeT0iLTAuMDA3IiB3aWR0aD0iMTEuOTQ5IiBoZWlnaHQ9IjMwLjk3OSIgc3R5bGU9ImZpbGw6bm9uZTsiLz4KICAgICAgICAgICAgPGc+CiAgICAgICAgICAgICAgICA8Y2xpcFBhdGggaWQ9Il9jbGlwMSI+CiAgICAgICAgICAgICAgICAgICAgPHJlY3QgeD0iMC4wNzIiIHk9Ii0wLjAwNyIgd2lkdGg9IjExLjk0OSIgaGVpZ2h0PSIzMC45NzkiLz4KICAgICAgICAgICAgICAgIDwvY2xpcFBhdGg+CiAgICAgICAgICAgICAgICA8ZyBjbGlwLXBhdGg9InVybCgjX2NsaXAxKSI+CiAgICAgICAgICAgICAgICAgICAgPGcgaWQ9ImNpcmNsZS1jb3B5LTMiIHRyYW5zZm9ybT0ibWF0cml4KDEsMCwwLDEsMC4wNzE1Nzc1LDAuOTkzMzI0KSI+CiAgICAgICAgICAgICAgICAgICAgICAgIDxnIGlkPSJQYXRoLTIiIHRyYW5zZm9ybT0ibWF0cml4KDAuNzA3MTA3LC0wLjcwNzEwNywwLjcwNzEwNywwLjcwNzEwNywtNy4wMjM1Myw2LjI2Nzk5KSI+CiAgICAgICAgICAgICAgICAgICAgICAgICAgICA8cGF0aCBkPSJNNCw4TDQsMTQiIHN0eWxlPSJmaWxsOm5vbmU7c3Ryb2tlOnJnYig1MSw1MSw1MSk7c3Ryb2tlLXdpZHRoOjFweDsiLz4KICAgICAgICAgICAgICAgICAgICAgICAgPC9nPgogICAgICAgICAgICAgICAgICAgICAgICA8ZyBpZD0iUGF0aC0yMSIgc2VyaWY6aWQ9IlBhdGgtMiIgdHJhbnNmb3JtPSJtYXRyaXgoMC43MDcxMDcsLTAuNzA3MTA3LDAuNzA3MTA3LDAuNzA3MTA3LC0zLjQ5OTE3LDkuNzkyMzUpIj4KICAgICAgICAgICAgICAgICAgICAgICAgICAgIDxwYXRoIGQ9Ik00LDhMNCwxNCIgc3R5bGU9ImZpbGw6bm9uZTtzdHJva2U6cmdiKDUxLDUxLDUxKTtzdHJva2Utd2lkdGg6MXB4OyIvPgogICAgICAgICAgICAgICAgICAgICAgICA8L2c+CiAgICAgICAgICAgICAgICAgICAgPC9nPgogICAgICAgICAgICAgICAgICAgIDxnIHRyYW5zZm9ybT0ibWF0cml4KDAuOTg0ODA4LC0wLjE3MzY0OCwwLjE3MzY0OCwwLjk4NDgwOCwtMTkuMzc5OSwtMy45NTE3MSkiPgogICAgICAgICAgICAgICAgICAgICAgICA8cGF0aCBkPSJNMTguNDU1LDE3LjMzNUwxNy40NjQsMTcuMzM1TDE3LjQ2NiwyMi43TDE4LjAzMywyMy41MTJMMTguNDUzLDIzLjUwOEwxOC40NTUsMTcuMzM1WiIgc3R5bGU9ImZpbGw6cmdiKDUxLDUxLDUxKTsiLz4KICAgICAgICAgICAgICAgICAgICA8L2c+CiAgICAgICAgICAgICAgICAgICAgPGcgdHJhbnNmb3JtPSJtYXRyaXgoLTAuMTczNjQ4LDAuOTg0ODA4LDAuOTg0ODA4LDAuMTczNjQ4LC0xMi41MDI4LC0xMC44MzAzKSI+CiAgICAgICAgICAgICAgICAgICAgICAgIDxwYXRoIGQ9Ik0xOC40NTUsMTcuMzM1TDE3LjQ2NCwxNy4zMzVMMTcuNDY2LDIyLjdMMTguMDMzLDIzLjUxMkwxOC40NTMsMjMuNTA4TDE4LjQ1NSwxNy4zMzVaIiBzdHlsZT0iZmlsbDpyZ2IoNTEsNTEsNTEpOyIvPgogICAgICAgICAgICAgICAgICAgIDwvZz4KICAgICAgICAgICAgICAgIDwvZz4KICAgICAgICAgICAgPC9nPgogICAgICAgIDwvZz4KICAgIDwvZz4KPC9zdmc+Cg==)
      • arrowhead (data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB3aWR0aD0iMTJweCIgaGVpZ2h0PSIzMHB4IiB2aWV3Qm94PSIwIDAgMTIgMzAiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayI+CiAgICA8IS0tIEdlbmVyYXRvcjogU2tldGNoIDYzLjEgKDkyNDUyKSAtIGh0dHBzOi8vc2tldGNoLmNvbSAtLT4KICAgIDx0aXRsZT5jaXJjbGUgY29weSAzPC90aXRsZT4KICAgIDxkZXNjPkNyZWF0ZWQgd2l0aCBTa2V0Y2guPC9kZXNjPgogICAgPGcgaWQ9ImNpcmNsZS1jb3B5LTMiIHN0cm9rZT0ibm9uZSIgc3Ryb2tlLXdpZHRoPSIxIiBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPgogICAgICAgIDxnIGlkPSJHcm91cCIgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoNS4wMDAwMDAsIDEzLjAwMDAwMCkgcm90YXRlKC00NS4wMDAwMDApIHRyYW5zbGF0ZSgtNS4wMDAwMDAsIC0xMy4wMDAwMDApIHRyYW5zbGF0ZSgxLjAwMDAwMCwgNi4wMDAwMDApIj4KICAgICAgICAgICAgPHBvbHlnb24gaWQ9IlRyaWFuZ2xlIiBmaWxsPSIjMzMzMzMzIiBwb2ludHM9IjQgMCA4IDggMCA4Ij48L3BvbHlnb24+CiAgICAgICAgICAgIDxsaW5lIHgxPSI0IiB5MT0iOCIgeDI9IjQiIHkyPSIxNCIgaWQ9IlBhdGgtMiIgc3Ryb2tlPSIjMzMzMzMzIiBvcGFjaXR5PSIwLjIwMDAwMDAwMyIgc3Ryb2tlLWxpbmVjYXA9InNxdWFyZSI+PC9saW5lPgogICAgICAgIDwvZz4KICAgIDwvZz4KPC9zdmc+)

      annotations.defaults.stroke_width number

      Width.

      Max: 4

      annotations.defaults.stroke_color color

      Color.

      annotations.defaults.connector_extend_line string

      Extend line.

      Allowed values:

      • enabled (Enable)
      • disabled (Disable)

      Animations

      animation_duration number

      Animation duration. The duration of the animation (in seconds) when changing data or mode – for example, between slides in a story

      Chart background

      chart_bg.background_color_enabled boolean

      Color.

      Allowed values:

      • true (On)
      • false (Off)

      chart_bg.background_image_enabled boolean

      Image.

      Allowed values:

      • true (On)
      • false (Off)

      chart_bg.background_color color

      Color.

      chart_bg.background_image_src url

      Image URL.

      chart_bg.background_image_size string

      Size.

      Allowed values:

      • stretch (Stretch)
      • slice (Fill)
      • meet (Fit)

      chart_bg.background_image_position string

      Position.

      Allowed values:

      • xMinYMin (Top left)
      • xMidYMin (Top center)
      • xMaxYMin (Top right)
      • xMaxYMid (Center left)
      • xMidYMid (Center)
      • xMaxYMid (Center right)
      • xMinYMax (Bottom left)
      • xMidYMax (Bottom center)
      • xMaxYMax (Bottom right)

      Layout

      Layout

      layout.body_font font

      Main font. This font will apply to the whole graphic by default. 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, You can optionally change the color for individual text elements, in other settings panels.

      layout.background_color_enabled boolean

      Color.

      Allowed values:

      • true (On)
      • false (Off)

      layout.background_image_enabled boolean

      Image.

      Allowed values:

      • true (On)
      • false (Off)

      layout.background_color color

      Background color.

      layout.background_image_src url

      Image URL.

      layout.background_image_size string

      Size.

      Allowed values:

      • cover (Fill)
      • contain (Fit)
      • auto (Original)
      • 100% 100% (Stretch)

      layout.background_image_position string

      Position.

      Allowed values:

      • top left (Top left)
      • top center (Top center)
      • top right (Top right)
      • center left (Center left)
      • center center (Center)
      • center right (Center right)
      • bottom left (Bottom left)
      • bottom center (Bottom center)
      • bottom right (Bottom right)

      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:

      • none (None)
      • wrapper (Everything)
      • primary (Main graphic)

      layout.max_width number

      Maximum width. Leave blank to stretch to container width

      Min: 50

      layout.max_width_align string

      Align.

      Allowed values:

      • left (fa-align-left)
      • center (fa-align-center)
      • right (fa-align-right)

      layout.layout_order string

      Layout order.

      Allowed values:

      • stack-default (Header – controls – legend – primary graphic – footer)
      • stack-2 (Primary graphic – header – controls – legend – footer)
      • stack-3 (Header – primary graphic – controls – legend – footer)
      • stack-4 (Controls – primary graphic – header – legend – footer)
      • grid-1 (Grid mode: Primary graphic on the right)

      layout.space_between_sections string

      Space between sections.

      Allowed values:

      • 0.5 (▁)
      • 1 (▃)
      • 1.5 (▄)
      • custom (...)

      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:

      • solid (Solid)
      • dashed (Dashed)
      • dotted (Dotted)

      layout.border.top.color color

      Color.

      layout.border.right.width number

      Right.

      layout.border.right.style string

      Style.

      Allowed values:

      • solid (Solid)
      • dashed (Dashed)
      • dotted (Dotted)

      layout.border.right.color color

      Color.

      layout.border.bottom.width number

      Bottom.

      layout.border.bottom.style string

      Style.

      Allowed values:

      • solid (Solid)
      • dashed (Dashed)
      • dotted (Dotted)

      layout.border.bottom.color color

      Color.

      layout.border.left.width number

      Left.

      layout.border.left.style string

      Style.

      Allowed values:

      • solid (Solid)
      • dashed (Dashed)
      • dotted (Dotted)

      layout.border.left.color color

      Color.

      layout.read_direction string

      Read direction. This will change the reading direction of the main text elements on the page. It's not possible to adjust this on all elements, such as axes.

      Note that when direction is set to right to left any alignment icons will be reversed.

      Allowed values:

      • ltr (Left to right)
      • rtl (Right to left)

      layout.font_size_mobile_small number

      layout.font_size_mobile_big number

      layout.font_size_tablet number

      layout.font_size_desktop number

      layout.font_size_big_screen number

      layout.breakpoint_mobile_small number

      layout.breakpoint_mobile_big number

      layout.breakpoint_tablet number

      layout.breakpoint_desktop number

      layout.breakpoint_big_screen number

      layout.header_align string

      Alignment.

      Allowed values:

      • left (fa-align-left)
      • center (fa-align-center)
      • right (fa-align-right)

      layout.title html

      layout.title_styling boolean

      Styling.

      layout.title_font font

      Title Font.

      layout.title_size string

      Size.

      Allowed values:

      • 1.4 (ᴀ)
      • 1.6 (A)
      • 2 (fa-font)
      • custom (...)

      layout.title_size_custom number

      Custom. Specify a custom responsive font size in rems. The best results will be with values between 1.2 and 3

      layout.title_weight string

      Weight.

      Allowed values:

      • bold (Bold)
      • normal (Regular)

      layout.title_color color

      Color.

      layout.title_line_height number

      Line height.

      Max: 3

      layout.title_space_above string

      Space above.

      Allowed values:

      • 0 (▁)
      • 0.5 (▃)
      • 1 (▄)
      • custom (...)

      layout.title_space_above_custom number

      Custom.

      Max: 100

      layout.subtitle html

      layout.subtitle_styling boolean

      Styling.

      layout.subtitle_font font

      Subtitle Font.

      layout.subtitle_size string

      Size.

      Allowed values:

      • 1.4 (ᴀ)
      • 1.6 (A)
      • 2 (fa-font)
      • custom (...)

      layout.subtitle_size_custom number

      Custom. Specify a custom responsive font size in rems. The best results will be with values between 1.2 and 3

      layout.subtitle_weight string

      Weight.

      Allowed values:

      • bold (Bold)
      • normal (Regular)

      layout.subtitle_color color

      Color.

      layout.subtitle_line_height number

      Line height.

      Max: 3

      layout.subtitle_space_above string

      Space above.

      Allowed values:

      • 0 (▁)
      • 0.5 (▃)
      • 1 (▄)
      • custom (...)

      layout.subtitle_space_above_custom number

      Custom.

      Max: 100

      layout.header_text html

      layout.header_text_styling boolean

      Styling.

      layout.header_text_size string

      Size.

      Allowed values:

      • 1.2 (ᴀ)
      • 1.4 (A)
      • 1.6 (fa-font)
      • custom (...)

      layout.header_text_size_custom number

      Custom. Specify a custom responsive font size in rems. The best results will be with values between 1.2 and 3

      layout.header_text_weight string

      Weight.

      Allowed values:

      • bold (Bold)
      • normal (Regular)

      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:

      • 0 (▁)
      • 0.5 (▃)
      • 1 (▄)
      • custom (...)

      layout.header_text_space_above_custom number

      Custom.

      Max: 100

      layout.header_border string

      Allowed values:

      • top (Top)
      • bottom (Bottom)
      • top_and_bottom (Top & bottom)
      • none (None)

      layout.header_border_width number

      Width.

      layout.header_border_color color

      Color.

      layout.header_border_style string

      Style.

      Allowed values:

      • solid (Solid)
      • dashed (Dashed)
      • dotted (Dotted)

      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

      Image.

      layout.header_logo_alt string

      Alt text.

      Link.

      layout.header_logo_height number

      Height.

      layout.header_logo_align string

      Align. Align logo inside either the header or the main visualization container

      Allowed values:

      • inside (Header)
      • outside (Main container)

      layout.header_logo_position_inside string

      Position.

      Allowed values:

      • top (Top)
      • left (Left)
      • right (Right)

      layout.header_logo_position_outside string

      Position.

      Allowed values:

      • left (Left)
      • right (Right)

      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.

      layout.footer_align string

      Alignment.

      Allowed values:

      • left (fa-align-left)
      • center (fa-align-center)
      • right (fa-align-right)
      • justify (fa-align-justify)

      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.

      Allowed values:

      • bold (Bold)
      • normal (Regular)

      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 html

      Note. To add the time/date stamp of when the data was last updated add {{data_last_updated}}. For example, "Last updated at {{data_last_updated}}". To customize the format, use the advanced options below.

      layout.footer_note_secondary html

      Note (secondary). The secondary note is placed below the source and primary note. To add the time/date stamp of when the data was last updated add {{data_last_updated}}. For example, "Last updated at {{data_last_updated}}". To customize the format, use the advanced options below.

      layout.advanced_note_styling boolean

      Advanced.

      layout.footer_timestamp_format string

      Time/date stamp formatting. To change the date/time format of your timestamp, choose from the below options or provide a custom date format in d3-time-format syntax

      Predefined values:

      • %H:%M:%S (13:39:13)
      • %I:%M %p (01:39 PM)
      • %H:%M (13:39)
      • %H:%M %p (13:39 PM)
      • %H:%M:%S, %d %b %Y (13:39:13, 28 Jan 2024)
      • %H:%M, %d %b %Y (13:39, 28 Jan 2024)
      • %H:%M, %d/%m/%Y (13:39, 28/01/2024)
      • %H:%M, %m/%d/%Y (13:39, 01/28/2024)
      • %H:%M, %d-%m-%Y (13:39, 28-01-2024)
      • %H:%M, %m-%d-%Y (13:39, 01-28-2024)
      • %d %b %Y (28 Jan 2024)
      • %m/%d/%Y (01/28/2024)
      • %d/%m/%Y (28/01/2024)
      • %m-%d-%Y (01-28-2024)
      • %d-%m-%Y (28-01-2024)
      • %Y-%m-%d (2024-01-28)
      • %Y-%m-%d %H:%M:%S (2024-01-28 13:39:13)

      layout.footer_logo_enabled boolean

      Image.

      Allowed values:

      • true (Enabled)
      • false (Disabled)

      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 color is dark

      layout.footer_logo_alt string

      Alt text.

      Link.

      layout.footer_logo_height number

      Height.

      layout.footer_logo_margin number

      Margin.

      layout.footer_logo_order string

      Position.

      Allowed values:

      • left (Left)
      • right (Right)

      layout.footer_align_vertical string

      V. align.

      Allowed values:

      • flex-start (Top)
      • center (Center)
      • flex-end (Bottom)

      layout.footer_border string

      Allowed values:

      • top (Top)
      • bottom (Bottom)
      • top_and_bottom (Top & bottom)
      • none (None)

      layout.footer_border_width number

      Width.

      layout.footer_border_color color

      Color.

      layout.footer_border_style string

      Style.

      Allowed values:

      • solid (Solid)
      • dashed (Dashed)
      • dotted (Dotted)

      layout.footer_border_space number

      Space. Space between border and footer text

      Accessibility

      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 not replicate your title, since that will also be read by screenreaders.

      layout.screenreader_label string

      Screenreader label. A short text label given to the main Flourish embed wrapper to provide an accessible name that is only visible to screenreaders. Added in the form of an "aria-label".

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

      Allowed values:

      • true (Hidden)
      • false (Readable)