Gantt chart

Show event timings and durations across categories

Updated 3 years ago to v2.0.2 by Flourish team

How to use this template

This template is great for showing project schedules. Each gantt is an event or task showing its start and end dates or times as well as the main category they belong to.

Data requirements

Your data would show one event per row as in this example:

start_date end_date project assignee department progress
01/05/2019 04/05/2019 Get oranges Biff Preparation 0.9
03/05/2019 07/05/2019 Get bowls Biff Preparation 1
08/05/2019 13/05/2019 Squeeze oranges Kipper Production 0.4
09/05/2019 12/05/2019 Filter juice Kipper Sales 0.6
13/05/2019 19/05/2019 Taste juice Biff Marketing 0.3

Usage

Your data should at least have a start and an end date or time as well as some project tasks or events - project in above example.

You would also typically define a grouping variable that categorizes your events by for example person or department responsible for the event - for example assignee in the table above.

You can optionally add a second grouping variable that adds some sensible colors to your gannts - department above. This coloring variable can be discrete as well as numerical like for example an importance score.

A progress variable between 0 and 1 (representing percentages between 0 and 100%) can further show how far along the process each task is.

Date and time handling

In order for your gantt bars to cover the period from the start all the way to the end date (or time) each event's end date should always be the first date after the event has finished. For example, if the event finishes on the 3rd of May your end_date would be 04/05/2019.

If you wanted to show an hourly gantt chart, you would need to follow the following datetime format: 2019-01-05T09:00:00.000Z, which - in this case - represents 9AM on the 1st of May 2019. In a next step you would use the X axis settings to to show only hours and minutes.

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

version: 2

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: {
        gantt: [
            [ "GanttColumn1Value1", "GanttColumn2Value1",
            [ "GanttColumn1Value2", "GanttColumn2Value2",
            [ "GanttColumn1Value3", "GanttColumn2Value3",
            ...
        ]
    }
}

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/gantt",
    version: "2",
    bindings: {
        gantt: {
            start_date: 0, // index of a column in your data
            end_date: 1, // index of a column in your data
        }
    },
    data: {
        gantt: [
            [ "GanttColumn1Value1", "GanttColumn2Value1",
            [ "GanttColumn1Value2", "GanttColumn2Value2",
            [ "GanttColumn1Value3", "GanttColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@flourish/gantt",
    version: "2",
    bindings: {
        gantt: {
            start_date: 0, // index of a column in your data
            end_date: 1, // index of a column in your data
            task: 2, // index of a column in your data
            grouping: 3, // index of a column in your data
            color: 4, // index of a column in your data
            progress: 5, // index of a column in your data
            metadata: [6, 7, ...], // index(es) of column(s) in your data
        }
    },
    data: {
        gantt: [
            [ "GanttColumn1Value1", "GanttColumn2Value1",
            [ "GanttColumn1Value2", "GanttColumn2Value2",
            [ "GanttColumn1Value3", "GanttColumn2Value3",
            ...
        ]
    }
}

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:

{
        gantt: [
            { "GanttHeader1": ..., "GanttHeader2": ..., ... },
            { "GanttHeader1": ..., "GanttHeader2": ..., ... },
            { "GanttHeader1": ..., "GanttHeader2": ..., ... },
            ...
        ]
    }

... 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/gantt",
    version: "2",
    bindings: {
        gantt: {
            start_date: "GanttHeader1",
            end_date: "GanttHeader2",
        }
    },
    data: {
        gantt: [
            { "GanttHeader1": ..., "GanttHeader2": ..., ... },
            { "GanttHeader1": ..., "GanttHeader2": ..., ... },
            { "GanttHeader1": ..., "GanttHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/gantt",
    version: "2",
    bindings: {
        gantt: {
            start_date: "GanttHeader1",
            end_date: "GanttHeader2",
            task: "GanttHeader3",
            grouping: "GanttHeader4",
            color: "GanttHeader5",
            progress: "GanttHeader6",
            metadata: ["GanttHeader7", "GanttHeader8", ...],
        }
    },
    data: {
        gantt: [
            { "GanttHeader1": ..., "GanttHeader2": ..., ... },
            { "GanttHeader1": ..., "GanttHeader2": ..., ... },
            { "GanttHeader1": ..., "GanttHeader2": ..., ... },
            ...
        ]
    }
}

(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/gantt",
    version: "2",
    data: {
    gantt: [
        {
            start_date: ...,
            end_date: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/gantt",
    version: "2",
    data: {
    gantt: [
        {
            start_date: ...,
            end_date: ...,
            task: ...,
            grouping: ...,
            color: ...,
            progress: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

  • gantt.start_date: start_date
  • gantt.end_date: The end date or hour of the event. If working with days, the end date should be the first day <b>after<b> the end date. So if your event stretches from 1.1. and ends on the 5.1. your end date should be the 6.1. This way your gantt bar will stretch across the last day of your project or task.
  • gantt.task: task
  • gantt.grouping: grouping
  • gantt.color: color
  • gantt.progress: This needs to be a decimal number between 0 and 1 representing the progress from 0-100%.
  • gantt.metadata: Add any columns here containing extra content to show in the popups

Template settings

Options for opts.state.

Gantts

gantt_height number

Gantt height. Choose between a minimum of 10 and a maximum of 50 pixels

Min: 10

Max: 50

border_radius number

Border radius.

Max: 20

gantt_progress boolean

Show gantt progress.

Allowed values:

  • true (Show)
  • false (Hide)

Labels

gantt_text boolean

Show gantt text.

Allowed values:

  • true (Show)
  • false (Hide)

gantt_font_size number

Size.

gantt_text_color color

Color.

gantt_font_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

X axis

x.axis_position string

Position.

Allowed values:

  • bottom (Bottom)
  • float-below (Float ↓)
  • float-above (Float ↑)
  • top (Top)
  • off (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.show_scale_settings boolean

Configure default min/max.

x.nice boolean

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

Allowed values:

  • true (On)
  • false (Off)

x.zero_axis string

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

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.

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

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. Ignored for date and numeric axes.

x.gridline_category_dividers_extend boolean

Extend. Extends the dividers into the axis margins.

date_format string

Date and Time Parsing. The date/time format in your data sheet. If it isn’t in the list, you can enter a custom format using d3-time-format syntax. See npmjs.com/package/d3-time-format for details.

Predefined values:

  • auto (Auto)
  • %Y-%m-%dT%H:%M:%S.%LZ (1986-01-28T11:39:13.000Z)
  • %Y-%m-%d (1986-01-28)
  • %m/%d/%Y (01/28/1986)
  • %d/%m/%Y (28/01/1986)
  • %d-%b-%y (28-Jan-86)
  • %m/%Y (01/1986)
  • %b %Y (Jan 1986)
  • %b '%y (Jan '86)
  • %B %d (January 28)
  • %d %b (28 Jan)
  • %Y (1986)
  • %B (January)
  • %b (Jan)
  • %A (Tuesday)
  • %a (Tue)
  • %H:%M:%S (11:39:13)
  • %I:%M %p (11:39 AM)
  • %H:%M (11:39)

format_locale string

Date and Time Locale. The regional date/time format (<em>date locale</em>).<br /><br />You can specify each part of the format in the fields below...

Allowed values:

  • none (Default)
  • ady (Adyghe)
  • af-NA (Afrikaans (Namibia))
  • af-ZA (Afrikaans (South Africa))
  • af (Afrikaans)
  • ak (Akan)
  • ar-MA (Arabic (Morocco))
  • ar-SA (Arabic (Saudi Arabia))
  • hy-AM (Armenian)
  • ay-BO (Aymara)
  • eu-ES (Basque)
  • be-BY (Belarusian)
  • bn-BD (Bengali (Bangladesh))
  • bn-IN (Bengali (India))
  • bn (Bengali)
  • bs-BA (Bosnian)
  • my (Burmese)
  • ck-US (Cherokee)
  • zh-CN (Chinese Simplified (China))
  • zh-SG (Chinese Simplified (Singapore))
  • zh-Hans (Chinese Simplified)
  • zh-HK (Chinese Traditional (Hong Kong))
  • zh-TW (Chinese Traditional (Taiwan))
  • zh-Hant (Chinese Traditional)
  • zh (Chinese)
  • gx-GR (Classical Greek)
  • nl-BE (Dutch (Belgium))
  • nl-NL (Dutch (Netherlands))
  • nl (Dutch)
  • en-AU (English (Australia))
  • en-CA (English (Canada))
  • en-IN (English (India))
  • en-IE (English (Ireland))
  • en@pirate (English (Pirate))
  • en-ZA (English (South Africa))
  • en-GB (English (UK))
  • en-UD (English (Upside Down))
  • en-US (English (US))
  • en (English)
  • eo-EO (Esperanto)
  • et-EE (Estonian (Estonia))
  • fo-FO (Faroese)
  • fi-FI (Finnish)
  • fr-BE (French (Belgium))
  • fr-CA (French (Canada))
  • fr-FR (French (France))
  • fr-CH (French (Switzerland))
  • fr (French)
  • fy-NL (Frisian (West))
  • ff (Fulah)
  • gl-ES (Galician)
  • ka-GE (Georgian)
  • de-AT (German (Austria))
  • de-DE (German (Germany))
  • de-CH (German (Switzerland))
  • de (German)
  • el-GR (Greek (Greece))
  • el (Greek)
  • gn-PY (Guarani)
  • gu-IN (Gujarati)
  • ht (Haitian Creole)
  • is-IS (Icelandic (Iceland))
  • is (Icelandic)
  • ga-IE (Irish (Gaelic))
  • ga (Irish)
  • jv-ID (Javanese)
  • kab (Kabyle)
  • kn-IN (Kannada (India))
  • kn (Kannada)
  • cak (Kaqchikel)
  • kk-KZ (Kazakh)
  • tlh (Klingon)
  • ko-KR (Korean (Korea))
  • ko (Korean)
  • ku-TR (Kurdish)
  • fb-LT (Leet)
  • li-NL (Limburgish)
  • dsb (Lower Sorbian)
  • lb (Luxembourgish)
  • mk-MK (Macedonian (Macedonian))
  • mk (Macedonian)
  • mai (Maithili)
  • mg-MG (Malagasy)
  • mn-MN (Mongolian)
  • se-NO (Northern S√°mi)
  • nn-NO (Norwegian (nynorsk))
  • no (Norwegian)
  • oc (Occitan)
  • or-IN (Oriya)
  • ps-AF (Pashto)
  • fa-IR (Persian full)
  • pt-BR (Portuguese (Brazil))
  • pt-PT (Portuguese (Portugal))
  • pt (Portuguese)
  • pa-IN (Punjabi (India))
  • pa (Punjabi)
  • qu-PE (Quechua)
  • rm-CH (Romansh)
  • sa-IN (Sanskrit)
  • sr-RS (Serbian (Serbia))
  • sr (Serbian)
  • si-LK (Sinhala (Sri Lanka))
  • sk-SK (Slovak (Slovakia))
  • sk (Slovak)
  • so-SO (Somali)
  • es-AR (Spanish (Argentina))
  • es-CL (Spanish (Chile))
  • es-CO (Spanish (Colombia))
  • es-EC (Spanish (Ecuador))
  • es-MX (Spanish (Mexico))
  • es-NI (Spanish (Nicaragua))
  • es-ES (Spanish (Spain))
  • es-US (Spanish (United States))
  • es-VE (Spanish (Venezuela))
  • es (Spanish)
  • su (Sundanese)
  • sw-KE (Swahili (Kenya))
  • sw (Swahili)
  • tt-RU (Tatar)
  • th-TH (Thai (Thailand))
  • th (Thai)
  • none (The default locale)
  • hsb (Upper Sorbian)
  • xh-ZA (Xhosa)
  • yi-DE (Yiddish (German))
  • yi (Yiddish)
  • zu-ZA (Zulu)

format_weekday string

Weekday.

Allowed values:

  • none (None)
  • narrow (Single letter)
  • short (Short)
  • long (Long)

format_year string

Year.

Allowed values:

  • none (None)
  • numeric (Full year)
  • 2-digit (2 digits)

format_month string

Month.

Allowed values:

  • none (None)
  • numeric (Number)
  • 2-digit (2 digits)
  • narrow (Single letter)
  • short (Short)
  • long (Long)

format_day string

Day.

Allowed values:

  • none (None)
  • numeric (Number)
  • 2-digit (2 digits)

format_hour string

Hour.

Allowed values:

  • none (None)
  • numeric (Number)
  • 2-digit (2 digits)

format_minute string

Minute.

Allowed values:

  • none (None)
  • numeric (Number)
  • 2-digit (2 digits)

Y axis

y_font_size number

Size.

y_font_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

y_font_fill color

Color.

y_text_dx number

x padding.

Max: 5

y_text_dy number

y padding.

Min: 1

Max: 5

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)

Colours

color.scale_type string

Scale type.

Allowed values:

  • categorical (Categorical)
  • numeric (Numeric)

color.categorical_palette colors

Palette.

color.categorical_extend boolean

Extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once.

color.categorical_custom_palette text

Custom overrides. Type the name of the entity whose colour you want to set, a colon and then a colour (using a name, hex-code or rgb declaration). Multiple colours can be set using multiple lines. For example:<br /><hr />Party 1: red<br />Party 2: #4455AA<br />Party 3: rgb(30,168,26)

color.numeric_type string

Scale type.

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. Write your custom thresholds, separated by a ";" For example 5;10;15

color.sequential_palette string

Palette.

Allowed values:

  • Oranges
  • Reds
  • Blues
  • Greens
  • Greys
  • Purples
  • Viridis
  • Inferno
  • Magma
  • Plasma
  • Warm
  • 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
  • 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.

color_single color

Color.

Legend

legend_discrete.show_legend boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

legend_discrete.text_color color

Color.

legend_discrete.text_size number

Size.

legend_discrete.text_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Normal)

legend_discrete.title_mode string

Title mode.

Allowed values:

  • auto (Auto)
  • fixed (Fixed)

legend_discrete.title string

Title.

legend_discrete.title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Normal)

legend_discrete.swatch_width number

Width.

legend_discrete.swatch_height number

Height.

legend_discrete.swatch_radius number

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

legend_discrete.order_override text

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

legend_discrete.orientation string

Orientation.

Allowed values:

  • horizontal (Horizontal)
  • vertical (Vertical)

legend_continuous.show_legend boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

legend_continuous.text_color color

Color.

legend_continuous.text_size number

Size.

legend_continuous.text_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Normal)

legend_continuous.title_mode string

Title mode.

Allowed values:

  • auto (Auto)
  • fixed (Fixed)

legend_continuous.title string

Title.

legend_continuous.title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Normal)

legend_continuous.color_band_width number

Width.

legend_continuous.color_band_height number

Height.

legend_continuous.color_band_radius number

Roundness. The radius of the corners of the color band (in pixels)

legend_continuous.binned_label_mode string

Binned label mode.

Allowed values:

  • thresholds (Thresholds)
  • centers (Centers)
  • custom (Custom)

legend_continuous.binned_label_custom string

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

legend_continuous.legend_min number

Legend min.

legend_continuous.legend_max number

Legend max.

Popups

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 string

Popup custom header. The text to appear in the popup. You can use {{column_name}} to add a value from your data. It must be in a selected column, but you can add columns to “Metadata” if you just want to include them for use in the popup. Advanced users can include HTML to apply layouts, formatting, images, etc.

popup.popup_custom_main text

Popup custom main content. The text to appear in the popup. You can use {{column_name}} to add a value from your data. It must be in a selected column, but you can add columns to “Metadata” if you just want to include them for use in the popup. Advanced users can include HTML to apply layouts, formatting, images, etc.

popup.popup_width number

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:

  • left (fa-align-left)
  • center (fa-align-center)
  • right (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_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 string

Panel custom header. The text to appear in the panel. You can use {{column_name}} to add a value from your data. It must be in a selected column, but you can add columns to “Metadata” if you just want to include them for use in the popup. Advanced users can include HTML to apply layouts, formatting, images, etc.

popup.panel_custom_main text

Panel custom main content. The text to appear in the panel. You can use {{column_name}} to add a value from your data. It must be in a selected column, but you can add columns to “Metadata” if you just want to include them for use in the popup. Advanced users can include HTML to apply layouts, formatting, images, etc.

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_text_color color

Text color.

popup.panel_font_size number

Text size.

popup.panel_align string

Alignment.

Allowed values:

  • left (fa-align-left)
  • center (fa-align-center)
  • right (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.

Layout

Layout

layout.body_font font

Main font. This font will apply to the whole graphic by default, but you can optionally change the font for the title, subtitle, footer, etc in the Header and Footer settings panels.

layout.font_color color

Text color. This color will apply to the whole graphic by default, but you can optionally change the color for individual text elements, in other settings panels.

layout.background_color_enabled boolean

Color.

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 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAANhJREFUSA3tVNEOwiAM7Iy/p2/wkTz6g5gjOVZZEepcjMmWLBTau95ugIh6lpzzLcb4wNpFJaRk9MIahxAyXmD7mC7BC2RlFbliQjFMpJTujOdGs/ECwRoP3rlKoEzNJlz3+CwutK0NLRVt2QhjggA9n2IGEKANMxmt0VVsEfxgzfX7zL3ZiqbXLjcKc8vEORk5/75mMB/7u11uuIpdbtDCc5R3l/s+e+pmHt1foza7Nv6IXOeHiqGk9zWtSk1cN2cPrItnYjZzHZEZYtacxHTiuANSO/xN8AS4uW8Rw1Gu2AAAAABJRU5ErkJggg==)
  • stack-2 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAAMpJREFUSA3tVMsKwyAQNKW/l970Iz32Bw0jjKTrSLUY0oOBsO5rnOwYnTs9W0ppDyG8EcsOkw8uauu9T3jR2+75yJxBnnC4JxMxxlezg0V9VsJsIGz75TfKdlkpg3aPcT8TsPNRMJjZEIf5xaAAahUyE+RtfcZvtFLoFh95aFXxH4hCWpUoTCg7fxqUfB4yEcl/CJlNy5qbfuZA8m8CwJ77q2djSj50lnuAWbOAOQlXxCuRHxcUje2XzfgrYzBpHUXLkmxh181SpnEAB4Vg0DSGhHsAAAAASUVORK5CYII=)
  • stack-3 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAANFJREFUSA3tVEEOwyAMo9O+193gkRz3QSZHMmNRUkGp1guVqkCIHZMAITTfVkrZU0pv+B7NQpCV1vEdxxgLfmB9jEvwBBNzkjXn/HIRDOqzJs0GwS1eEmonAn52RITJaUYScd5KLl0fTQf58HVpIFlXMDPNBVMf2TDXPq7dZM2eelrMQ6uDucG50mlWzG/ooCWDvqENXldn1pcyhpgJWjYcPe5z5ZFrAgoe2LN0f2v1ZYq5UyofuiME99hFXKtUm1c9aoBmeEeRjVIQma6XpVblAwnpZjN/VjqsAAAAAElFTkSuQmCC)
  • stack-4 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAANtJREFUSA3tVNEOwjAI3Iy/p2/tR/bRH6zekmuA1glO45bYZAHKcdDCOk1izbXWC+0zlJzzDVJ5sNGW9qSUKj4QKY8yWvBDUWnoKKVcTzS2yWHiIfeMwm2yIbLbRL3DRJYubi+0bAPCkcvapO3AdFgZvuDuyJZR2i4wSpBBP9ZD7RsOLQ9gD/Y5ZmaA3EEHWY6r3SEwrzDEHLpnlvOXa4/7xttZfhNwyPdKcqLPaz6JlXpr9bNgCfbobw2ch5iY0CQzyCOPR9ya5zleBPNy3LxknAbiv1YxExxH3gEqBW7I4zw3PQAAAABJRU5ErkJggg==)

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

Alignment.

Allowed values:

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

layout.title string

layout.title_styling boolean

Change title styles.

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

layout.subtitle_styling boolean

Change subtitle styles.

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

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

URL.

layout.header_logo_height number

Height.

layout.header_logo_align string

Align. Align logo inside header or outer visualisation container

Allowed values:

  • outside (Outside)
  • inside (Inside)

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

Source name.

layout.source_url string

Source url.

layout.multiple_sources boolean

Multiple sources.

layout.source_name_2 string

Source name.

layout.source_url_2 string

Source url.

layout.source_name_3 string

Source name.

layout.source_url_3 string

Source url.

layout.source_label string

Source label.

layout.footer_note string

Note.

layout.footer_note_secondary string

Note (secondary). The secondary note is placed below the source and primary note

layout.footer_logo_enabled boolean

Image.

Allowed values:

  • 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 colour is dark

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)
  • 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_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)

layout.screenreader_text_primary text

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