Slope chart

Ideal for visualizing change between time periods

Updated 25 days ago to v14.0.2 by Flourish team

How to use this template

Slope chart

A simple charting template to plot the differences between two values. Useful to compare the difference in population, income or wealth.

Data requirements

Each row after the header row is one slope. There should be a column for the name and two columns for the values. The values should be of the same data type (eg. votes, income, population).

Credits and feedback

Created by Flourish. Sample data is from the World Bank illustrating exports of goods and services as percentage of GDP per country. The slope with an activated filter uses data from the MIT Election Lab. 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/slope-chart

version: 14

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/slope-chart",
    version: "14",
    bindings: {
        data: {
            id: 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/slope-chart",
    version: "14",
    bindings: {
        data: {
            id: 0, // index of a column in your data
            values: [1, 2, ...], // index(es) of column(s) in your data
            line_thickness: 3, // index of a column in your data
            filter: 4, // index of a column in your data
            color_category: 5, // index of a column in your data
            facet: 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/slope-chart",
    version: "14",
    bindings: {
        data: {
            id: "DataHeader1",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/slope-chart",
    version: "14",
    bindings: {
        data: {
            id: "DataHeader1",
            values: ["DataHeader2", "DataHeader3", ...],
            line_thickness: "DataHeader4",
            filter: "DataHeader5",
            color_category: "DataHeader6",
            facet: "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/slope-chart",
    version: "14",
    data: {
    data: [
        {
            id: ...,
            values: [...],
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/slope-chart",
    version: "14",
    data: {
    data: [
        {
            id: ...,
            values: [...],
            line_thickness: ...,
            filter: ...,
            color_category: ...,
            facet: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

  • data.id: The name of the data series (eg. voting district, data mode)
  • data.values: Values for that data series (eg. % of votes).
  • data.line_thickness: Values for the thickness of line
  • data.filter: filter string, number, datetime
  • data.color_category: color_category
  • data.facet: facet
  • 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 custom <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups">popups and panels</a> string, number, 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/slope-chart",
    version: "14",
    ...
    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. 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/slope-chart",
    version: "14",
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    },
    metadata: {
        data: {
            "DataHeader1": { type: ..., type_id: ..., output_format_id: ... },
            "DataHeader2": { 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.

Slopes

circle_radius number

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

slope_width number

Slope width. In pixels

slope_width_max number

Max slope width.

slope_color color

Slope color. If not set, will use same color as main text

curve string

Line curve.

Allowed values:

  • linear (Straight)
  • cardinal (Curve)
  • step (Step)

color.categorical_palette colors

Palette for categories.

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.

      selected_slopes text

      Highlight slopes. To highlight slopes, write the name of each slope on a line. You can also create a story and highlight/unhighlight by clicking on a slope. Leave empty to highlight all slopes.

      Chart mode

      value_type string

      Value mode.

      Allowed values:

      • ranks (Ranks)
      • scores (Scores)
      • change (% change)

      ties_mode string

      Ties mode. What rank should be given when there are ties? See https://en.wikipedia.org/wiki/Ranking for explanation of nomenclature

      Allowed values:

      • dense (1 2 2 3)
      • competition (1 2 2 4)
      • fractional (1 2.5 2.5 4)
      • modified_competition (1 3 3 4)

      sort_mode string

      Sort mode.

      Allowed values:

      • descending (Descending)
      • ascending (Ascending)

      height_mode string

      Height mode.

      Allowed values:

      • auto (Auto)
      • aspect_ratio (Aspect ratio)

      aspect_ratio number

      Aspect ratio. 1 for square, a smaller value means a bigger height.

      Min: 0.1

      Max: 10

      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

      axis_first_row_only boolean

      Show X axis on first row only.

      matching_y_axis boolean

      Matching Y scale across facets.

      Labels

      labels_name_position string

      Slope name mode.

      Allowed values:

      • side (Side)
      • inline (Inline)
      • none (None)

      labels_position string

      Slope name position. Both mode will fallback to Start on narrow windows and devices

      Allowed values:

      • start (fa-align-left)
      • both (Both)
      • end (fa-align-right)

      labels_inline_position string

      Slope name position.

      Allowed values:

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

      labels_inline_position_custom text

      Custom slope name positions. Change the position of each individual label. One line per label.

      Syntax
      Label name :: start/middle/end :: offset in % (optional)

      Example
      Luxembourg :: end :: 10
      France :: start

      only_show_highlights boolean

      Only show highlighted labels.

      line_labels.max_width number

      Max label width. The maximum allowed label width

      line_labels.overlap_mode string

      Overlaps. What to do with overlaps

      Allowed values:

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

      line_labels.spreading_margin number

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

      line_labels.data_point_margin number

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

      line_labels.show_only_labels text

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

      line_labels.text_color color

      Color.

      line_labels.text_size number

      Size.

      Max: 100

      line_labels.text_bg_color color

      Outline.

      line_labels.text_bg_size number

      Outline width. As a % of the font size

      Max: 100

      line_labels.text_line_height number

      Line height.

      line_labels.text_max_lines number

      Max lines. The max number of lines for each label

      line_labels.text_weight string

      Weight.

      Predefined values:

      • 400 (Normal)
      • 700 (Bold)

      line_labels.lines string

      Connector lines.

      Allowed values:

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

      line_labels.line_style string

      Line style.

      Allowed values:

      • straight (Straight)
      • step (Step)

      line_labels.line_color color

      Color.

      line_labels.line_width number

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

      Max: 0.5

      line_labels.line_range number

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

      line_labels.line_padding number

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

      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.

      Axis

      axis_labels_position string

      Position.

      Allowed values:

      • top (Top)
      • bottom (Bottom)
      • hidden (Hidden)

      axis_font_size number

      Font size.

      axis_text_color color

      Font color.

      axis_color color

      Axis color.

      axis_width number

      Axis width.

      axis_dashoffset string

      Axis dash. eg. 2,2

      Controls

      update_y_axis_filter boolean

      Update Y axis when filtering.

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

      controls.control_styles boolean

      Adv..

      controls.control_title string

      Control title.

      controls.button_group boolean

      Grouped.

      Allowed values:

      • true (On)
      • false (Off)

      controls.button_group_width_mode string

      Button group width.

      Allowed values:

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

      controls.button_group_width_fixed number

      Width.

      Max: 100

      controls.dropdown_width_mode string

      Dropdown width.

      Allowed values:

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

      controls.dropdown_width_fixed number

      Width.

      Max: 100

      controls.slider_width number

      Slider width. Width of the slider track in rems

      Max: 100

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

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

      controls.slider_loop boolean

      Loop.

      controls.slider_restart_pause number

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

      Max: 100

      controls.sort boolean

      Sorting.

      Allowed values:

      • true (On)
      • false (Off)

      filter_show_all boolean

      Include "All".

      filter_show_all_text string

      “All” label.

      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

      slider_style.track_color color

      Track.

      slider_style.font_color color

      Text.

      slider_style.handle_color color

      Handle.

      slider_style.play_color color

      Play/pause.

      slider_style.track_height number

      Track height.

      Max: 1

      slider_style.handle_height number

      Height.

      Max: 10

      slider_style.play_button boolean

      Play button.

      Animations

      animation_duration number

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

      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

      Number formatting

      formatting.prefix string

      Prefix. Text to place in front of a number

      formatting.suffix string

      Suffix. Text to place after a number

      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

      formatting.advanced boolean

      Advanced.

      formatting.negative_sign string

      Styling of negative numbers.

      Allowed values:

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

      formatting.strip_zeros boolean

      Remove trailing zeros.

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

      formatting.transform_labels boolean

      Multiply/divide values.

      formatting.transform string

      Allowed values:

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

      formatting.multiply_divide_constant number

      formatting.exponentiate_constant number

      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)

      URL settings

      url_state.enabled boolean

      Update project from URL. Make it possible to change the visualization's settings/state from the URL hash, for example when embedding in an iframe or popup panel

      url_state.whitelist text

      Allowed state properties. List each state property you want to make changeable with the URL hash. See the template page for a full list of state properties.

      Add one property name per line. Use dot format for nested properties, e.g. layout.background_color.