Calendar
Updated 14 hours ago to v2.1.1 by Flourish team
How to use this template
Data structure
Each row in your Events datasheet should represent an event that has a particular date (optionally at a specific time). Upload data that includes one column containing dates and a column to color by or have represented as icons.
If you want to make a calendar with icons, your Color by or icon column should contain categories. You can also include columns for Event names, Filter and extra information to show in popups or panels.
Your data might look like:
Date | Event name | Icon category |
---|---|---|
12/08/2016 | 400m relay | Athletics |
21/08/2016 | Long jump | Athletics |
08/08/2016 | Opening ceremony | Ceremony |
If you want to make a heatmap, this column should contain numbers (for example, the frequency of some data variable on the given date).
For a heatmap, your data might look like:
Date | Rainfall (mm) |
---|---|
01/01/2024 | 2.3 |
02/01/2024 | 0.7 |
03/01/2024 | 0.2 |
Customizing your calendar
Use the settings panel to choose your Calendar layout: Yearly, Monthly, Weekly or Continuous. If your data spans over the chosen timeframe, new "pages" are added along with navigation buttons for the user to click between them.
The settings available allow you to customize how dates display, from the Locale, to the start day for the week, and whether headers should be abbreviated.
Using custom icons
If you are making a calendar with icons, you can add custom icons in the form of either image uploads, Font Awesome icons or emoji.
Upload data in the Icons datasheet to describe which icons should be used for which categories.
You should include two columns:
The first for the Category, which should match with values in your Color by or Icon column in the Events datasheet.
The second column, Icon, should contain the icon for that category. You can type an emoji directly in the datasheet, or right-click and upload an image icon. Alternatively, you can use Font Awesome icons by including keywords for particular icons in the Icon column.
Your Icons datasheet might look like:
Category | Icon |
---|---|
Athletics | πββοΈ |
Swimming | person-swimming |
Ceremony | medal |
Feedback
Want to see additional features? Let us know at support@flourish.studio.
API information
This section documents API usage specific to this template, so for an introduction we suggest you refer to the generic API documentation instead.
template: @flourish/calendar
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: { events: [ [ "EventsColumn1Value1", "EventsColumn2Value1", [ "EventsColumn1Value2", "EventsColumn2Value2", [ "EventsColumn1Value3", "EventsColumn2Value3", ... ], icons: [ [ "IconsColumn1Value1", "IconsColumn2Value1", [ "IconsColumn1Value2", "IconsColumn2Value2", [ "IconsColumn1Value3", "IconsColumn2Value3", ... ] } }
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/calendar", version: "2", bindings: { events: { date: 0, // index of a column in your data }, icons: { } }, data: { events: [ [ "EventsColumn1Value1", "EventsColumn2Value1", [ "EventsColumn1Value2", "EventsColumn2Value2", [ "EventsColumn1Value3", "EventsColumn2Value3", ... ], icons: [ [ "IconsColumn1Value1", "IconsColumn2Value1", [ "IconsColumn1Value2", "IconsColumn2Value2", [ "IconsColumn1Value3", "IconsColumn2Value3", ... ] } }
All possible bindings that you can supply are shown in this example:
{ template: "@flourish/calendar", version: "2", bindings: { events: { date: 0, // index of a column in your data name: 1, // index of a column in your data color: 2, // index of a column in your data filter: 3, // index of a column in your data metadata: [4, 5, ...], // index(es) of column(s) in your data }, icons: { category: 0, // index of a column in your data icon: 1, // index of a column in your data } }, data: { events: [ [ "EventsColumn1Value1", "EventsColumn2Value1", [ "EventsColumn1Value2", "EventsColumn2Value2", [ "EventsColumn1Value3", "EventsColumn2Value3", ... ], icons: [ [ "IconsColumn1Value1", "IconsColumn2Value1", [ "IconsColumn1Value2", "IconsColumn2Value2", [ "IconsColumn1Value3", "IconsColumn2Value3", ... ] } }
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:
{ events: [ { "EventsHeader1": ..., "EventsHeader2": ..., ... }, { "EventsHeader1": ..., "EventsHeader2": ..., ... }, { "EventsHeader1": ..., "EventsHeader2": ..., ... }, ... ], icons: [ { "IconsHeader1": ..., "IconsHeader2": ..., ... }, { "IconsHeader1": ..., "IconsHeader2": ..., ... }, { "IconsHeader1": ..., "IconsHeader2": ..., ... }, ... ] }
... 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/calendar", version: "2", bindings: { events: { date: "EventsHeader1", }, icons: { } }, data: { events: [ { "EventsHeader1": ..., "EventsHeader2": ..., ... }, { "EventsHeader1": ..., "EventsHeader2": ..., ... }, { "EventsHeader1": ..., "EventsHeader2": ..., ... }, ... ], icons: [ { "IconsHeader1": ..., "IconsHeader2": ..., ... }, { "IconsHeader1": ..., "IconsHeader2": ..., ... }, { "IconsHeader1": ..., "IconsHeader2": ..., ... }, ... ] } }
All possible bindings that you can supply are shown in this example:
{ template: "@flourish/calendar", version: "2", bindings: { events: { date: "EventsHeader1", name: "EventsHeader2", color: "EventsHeader3", filter: "EventsHeader4", metadata: ["EventsHeader5", "EventsHeader6", ...], }, icons: { category: "IconsHeader1", icon: "IconsHeader2", } }, data: { events: [ { "EventsHeader1": ..., "EventsHeader2": ..., ... }, { "EventsHeader1": ..., "EventsHeader2": ..., ... }, { "EventsHeader1": ..., "EventsHeader2": ..., ... }, ... ], icons: [ { "IconsHeader1": ..., "IconsHeader2": ..., ... }, { "IconsHeader1": ..., "IconsHeader2": ..., ... }, { "IconsHeader1": ..., "IconsHeader2": ..., ... }, ... ] } }
(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/calendar", version: "2", data: { events: [ { date: ..., metadata: [...] }, ... ] }, ... }
And the full list of all possible properties is as follows:
{ template: "@flourish/calendar", version: "2", data: { events: [ { date: ..., name: ..., color: ..., filter: ..., metadata: [...] }, ... ], icons: [ { category: ..., icon: ... }, ... ] }, ... }
Meanings of the template data keys:
- events.date: date
- events.name: When your <b>Color by or icon</b> column is categorical, add a column of event names here to display in the panel content
- events.color: You can either represent events by Color or by Icons. When Coloring by, this can be a column of numbers or categories. A number column will color cells numerically, while a category column will use the color palette. <br><br> To use icons, this column should contain categories that match those in the <b>Category</b> column in the Icons sheet and the relevant icons will be retrieved. Where an icon is used for a category, it will no longer take on a color from the color palette. string, number
- events.filter: filter string, number, datetime
- events.metadata: One or more columns of information to be included in popups and panels string, number, datetime
- icons.category: Categories should exactly match those in the column bound to <b>Color by or Icon</b> in the Events sheet, and should not be repeated. Where a category that exists in the Events sheet doesn't have a corresponding icon in the Icons sheet, the category will fallback to use a simple shape icon colored by the color palette.
- icons.icon: An emoji, uploaded image or Font Awesome icon keyword for the icon to be used for this category. The <a href="https://fontawesome.com/search?m=free&o=r"> <b>Font Awesome icons found at this link</b></a> are supported.
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/calendar", version: "2", ... data: { events: [ [ "EventsColumn1Value1", "EventsColumn2Value1", [ "EventsColumn1Value2", "EventsColumn2Value2", [ "EventsColumn1Value3", "EventsColumn2Value3", ... ], icons: [ [ "IconsColumn1Value1", "IconsColumn2Value1", [ "IconsColumn1Value2", "IconsColumn2Value2", [ "IconsColumn1Value3", "IconsColumn2Value3", ... ] }, metadata: { events: { 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/calendar", version: "2", data: { events: [ { "EventsHeader1": ..., "EventsHeader2": ..., ... }, { "EventsHeader1": ..., "EventsHeader2": ..., ... }, { "EventsHeader1": ..., "EventsHeader2": ..., ... }, ... ], icons: [ { "IconsHeader1": ..., "IconsHeader2": ..., ... }, { "IconsHeader1": ..., "IconsHeader2": ..., ... }, { "IconsHeader1": ..., "IconsHeader2": ..., ... }, ... ] }, metadata: { events: { "EventsHeader1": { type: ..., type_id: ..., output_format_id: ... }, "EventsHeader2": { 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
.
Calendar
layout_mode string
Mode. Allowed values:
continuous_rows number
Rows. Min: 1 Max: 500
continuous_columns number
Columns. Min: 1 Max: 500
continuous_cell_text string
Content. Allowed values:
continuous_cell_text_prefix string
Prefix.
continuous_cell_text_separator string
Separator.
format_locale string
Locale. The regional date/time format (date locale) that will change the locale of headers. Allowed values:
week_start string
Week start day. Allowed values:
today_enabled boolean
Highlight today.
today_start boolean
Load on today's date. When enabled, if today's date is included in the data, the calendar will load on the page where today's date is shown.
today_style_enabled boolean
Style today cell.
today_bold boolean
Bold.
today_border_color color
Stroke color.
today_border_width number
Stroke width. Max: 40
event_mode string
Mode. In Icons mode, each cell shows an icon for each event on that date found in the datasheet. In Fill mode, cells are filled by the color of the events in the datasheet. Allowed values:
If your data only ever has one event per day, cells will be filled categorically or numerically, depending on the type of data in the column bound to Value. If any dates have more than one event, in Fill mode all cells will be filled numerically by a count of events on that date.
height_mode string
Mode. Auto mode sets cells to have an aspect ratio of 1 by default but will expand height to fit icons in cells, where necessary.Cell aspect sets the height based on a specified aspect ratio applied to each cell. Allowed values:
cell_aspect_desktop number
Desktop. Max: 5
cell_aspect_mobile number
Mobile. Max: 5
cell_aspect_breakpoint number
Breakpoint. Max: 3000
Page header & navigation
page_header_alignment string
Alignment. Allowed values:
page_header_content string
Content. Allowed values:
page_header_text_size number
Size. Specify a custom responsive font size in rems Max: 5
page_header_padding number
Padding. Max: 3
page_header_text_weight string
Weight. Allowed values:
page_header_text_color color
Color.
navigation_icon_mode string
Icon. If all your dates from the datasheet fit onto one page, no navigation icons will be visible Allowed values:
navigation_icon_size number
Size. Specify a custom responsive size in rems Max: 10
navigation_icon_color color
Color.
navigation_icon_custom url
Custom icon. Upload an icon for the "next" icon (i.e. pointing to the right). Your icon will be rotated for the "previous" icon.
Column & row headers
column_header_length string
Preferred column header length. If the chosen length of header does not fit all headers without overlapping, headers will be abbreivated further in order to fit in the given space Allowed values:
row_header_length string
Row header length. Allowed values:
header_text_size number
Size. Specify a custom responsive font size in rems Max: 5
header_cell_padding number
Padding. Min: 0.2 Max: 10
header_text_weight string
Weight. Allowed values:
header_text_color color
Color.
column_header_alignment string
Column header alignment. Allowed values:
row_header_alignment string
Row header alignment. Allowed values:
Cells
cell_horizontal_alignment string
Horizontal alignment. Allowed values:
cell_text_weight string
Text weight. Allowed values:
cell_text_size number
Size. Specify a custom responsive font size in rems Max: 5
cell_text_color color
Color.
cell_background_color color
Background.
cell_empty_background_color color
Empty cells. When nulled, empty cells will use the cell background color or fallback to the layout background color
cell_min_width number
Min width. Specified in px. On smaller devices, cells will only shrink to fit the graphic up to this size. For example, in yearly mode on small devices once cells shrink to this size the graphic will then overflow horizontally. Max: 100
cell_inner_padding number
Padding inside cells. Max: 3
cell_outer_padding number
Padding between cells. Max: 5
cell_border_color color
Color.
cell_border_opacity number
Opacity. Max: 1
cell_border_width number
Width. Specified in px. Cell border width cannot be set to greater than a quarter of the width of the cell. Max: 40
cell_border_radius number
Roundness. Max: 10
Icons
icon_size number
Size. Specify a custom responsive size in rems Max: 8
icon_roundness number
Roundness. When there is no Icon binding (or no valid icon) events use a simple shape icon. Use this setting to create rounder shapes. As a %, where 100 creates a circular icon. Max: 100
icon_default_color color
Default color. When there is no Color by binding, icons that can be filled will use this color.
icon_overflow_text_mode string
Overflow text content. When not all icons fit in cells, text indicating the number of remaining icons will appear. E.g. "3 more" Allowed values:
icon_overflow_text_custom string
Custom overflow text.
Colors
fill_mode_numeric boolean
Scale type. Allowed values:
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:
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:
color.bin_mode string
Binning mode. Allowed values:
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:
For "5;10;15", you'll get four bins based on your data's range.
color.sequential_palette string
Palette. Allowed values:
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:
color.sequential_custom_domain boolean
Domain. Allowed values:
color.sequential_domain_min number
Min.
color.sequential_domain_max number
Max.
color.diverging_palette string
Palette. Allowed values:
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:
color.diverging_custom_domain boolean
Domain. Allowed values:
color.diverging_domain_min number
Min.
color.diverging_domain_mid number
Mid.
color.diverging_domain_max number
Max.
Controls & filters
controls_container.alignment string
Alignment. Allowed values:
controls_container.controls_spacing number
Spacing. The space between controls, like dropdowns and adjacent button sets, in em units. Max: 5
filter_control.control_type string
Control type. Choose between a dropdown, buttons or a time slider. Allowed values:
filter_control.control_styles boolean
Adv..
filter_control.control_title string
Control title.
filter_control.button_group boolean
Grouped. Allowed values:
filter_control.button_group_width_mode string
Button group width. Allowed values:
filter_control.button_group_width_fixed number
Width. Max: 100
filter_control.dropdown_width_mode string
Dropdown width. Allowed values:
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:
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:
controls_style.height number
Height. Max: 5
dropdown_style.background color
Background.
dropdown_style.font_color color
Text color.
dropdown_style.border_styles_advanced boolean
Dropdown border styles.
dropdown_style.border_style string
Border style. Show border on all sides, or only at the bottom Allowed values:
dropdown_style.border_width number
Border width. Max: 20
dropdown_style.border_color color
Color.
dropdown_style.border_transparency number
Transparency. Max: 1
dropdown_style.border_radius number
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.
Legend
legend_filtering_mode string
Clickable legend. When a legend item is clicked on, the corresponding dots can either be hidden or shown. This option can also be turned off. Allowed values:
legend_categorical.show_legend boolean
Legend mode. A legend will not show with a single entry Allowed values:
legend_categorical.title_mode string
Title mode. Allowed values:
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:
legend_continuous.show_legend boolean
Allowed values:
- true (Enabled)
- false (Disabled)
legend_continuous.title_mode string
Title mode. Allowed values:
legend_continuous.title string
Title.
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:
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.additional_min_label string
Custom min label.
legend_continuous.legend_max number
Legend max.
legend_continuous.additional_max_label string
Custom max label.
legend_container.alignment string
Alignment. Allowed values:
legend_container.orientation string
Orientation. Allowed values:
legend_container.title_weight string
Title weight. Allowed values:
legend_container.text_weight string
Text weight. Allowed values:
legend_container.text_color color
Color.
legend_container.text_size number
Size. Max: 10
Popups & panels
popup_enabled boolean
Allowed values:
- true (Enabled)
- false (Disabled)
panel_metadata_mode string
Panel content mode. Event name and Color by or icon information is shown in every mode. The modes change how any additional columns bound are shown: Allowed values:
For example, when a column called "Group" is bound to Filter, and columns named "Location" and "Result" are bound to Info for popups, the extra panel content will look like:
Group: Group A
Location: Millennium Stadium Result: 2 - 1
Group A
Millennium Stadium2 - 1
panel_inline_separator string
Separator.
popup.mode string
Allowed values:
- none (None)
- popup (Popup)
- panel (Panel)
- both (Both)
popup.popup_is_custom boolean
Popup content. Allowed values:
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:
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:
popup.popup_header_background color
Background.
popup.popup_header_text_color color
Text.
popup.popup_list_type string
List type. Allowed values:
popup.popup_list_label_weight string
Label weight. Allowed values:
popup.popup_list_separator string
List separator. Predefined values:
popup.popup_shadow boolean
Shadow.
popup.popup_pointer boolean
Pointer.
popup.panel_position string
Panel position. Allowed values:
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:
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:
popup.panel_text_color color
Text color.
popup.panel_font_size number
Text size.
popup.panel_align string
Alignment. Allowed values:
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:
popup.panel_list_label_weight string
Label weight. Allowed values:
popup.panel_list_separator string
List separator. Predefined values:
popup.panel_shadow boolean
Shadow.
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:
layout.background_image_enabled boolean
Image. Allowed values:
layout.background_color color
Background color.
layout.background_image_src url
Image URL.
layout.background_image_size string
Size. Allowed values:
layout.background_image_position string
Position. Allowed values:
layout.max_width_target string
Maximum width. Apply a maximum width to just the main graphic or everything (main graphic plus header, footer, etc). Allowed values:
layout.max_width number
Maximum width. Leave blank to stretch to container width Min: 50
layout.max_width_align string
Align. Allowed values:
layout.layout_order string
Layout order. Allowed values:
layout.space_between_sections string
Space between sections. Allowed values:
layout.space_between_sections_custom number
Custom. Max: 100
layout.margin_top number
Top.
layout.margin_right number
Right.
layout.margin_bottom number
Bottom.
layout.margin_left number
Left.
layout.border.enabled boolean
Show borders around visualisation.
layout.border.top.width number
Top.
layout.border.top.style string
Style. Allowed values:
layout.border.top.color color
Color.
layout.border.right.width number
Right.
layout.border.right.style string
Style. Allowed values:
layout.border.right.color color
Color.
layout.border.bottom.width number
Bottom.
layout.border.bottom.style string
Style. Allowed values:
layout.border.bottom.color color
Color.
layout.border.left.width number
Left.
layout.border.left.style string
Style. Allowed values:
layout.border.left.color color
Color.
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. Allowed values:
Note that when direction is set to right to left any alignment icons will be reversed.
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
Header
layout.header_align string
Alignment. Allowed values:
layout.title html
layout.title_styling boolean
Styling.
layout.title_font font
Title Font.
layout.title_size string
Size. Allowed values:
layout.title_size_custom number
Custom. Specify a custom responsive font size in rems. The best results will be with values between 1.2 and 3
layout.title_weight string
Weight. Allowed values:
layout.title_color color
Color.
layout.title_line_height number
Line height. Max: 3
layout.title_space_above string
Space above. Allowed values:
layout.title_space_above_custom number
Custom. Max: 100
layout.subtitle html
layout.subtitle_styling boolean
Styling.
layout.subtitle_font font
Subtitle Font.
layout.subtitle_size string
Size. Allowed values:
layout.subtitle_size_custom number
Custom. Specify a custom responsive font size in rems. The best results will be with values between 1.2 and 3
layout.subtitle_weight string
Weight. Allowed values:
layout.subtitle_color color
Color.
layout.subtitle_line_height number
Line height. Max: 3
layout.subtitle_space_above string
Space above. Allowed values:
layout.subtitle_space_above_custom number
Custom. Max: 100
layout.header_text html
layout.header_text_styling boolean
Styling.
layout.header_text_size string
Size. Allowed values:
layout.header_text_size_custom number
Custom. Specify a custom responsive font size in rems. The best results will be with values between 1.2 and 3
layout.header_text_weight string
Weight. Allowed values:
layout.header_text_color color
Color.
layout.header_text_line_height number
Line height. Max: 3
layout.header_text_space_above string
Space above. Allowed values:
layout.header_text_space_above_custom number
Custom. Max: 100
layout.header_border string
Allowed values:
- top (Top)
- bottom (Bottom)
- 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:
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.
layout.header_logo_link_url string
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:
layout.header_logo_position_inside string
Position. Allowed values:
layout.header_logo_position_outside string
Position. Allowed values:
layout.header_logo_margin_top number
Top.
layout.header_logo_margin_right number
Right.
layout.header_logo_margin_bottom number
Bottom.
layout.header_logo_margin_left number
Left.
Footer
layout.footer_align string
Alignment. Allowed values:
layout.footer_text_size number
Size.
layout.footer_text_color color
Color.
layout.footer_styling boolean
Advanced footer styles.
layout.footer_font font
Font.
layout.footer_text_weight string
Weight. Allowed values:
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:
layout.footer_logo_enabled boolean
Image. Allowed values:
layout.footer_logo_src url
Image.
layout.footer_logo_src_light hidden
Image (light version). If provided this version will be used whenever the background color is dark
layout.footer_logo_alt string
Alt text.
layout.footer_logo_link_url string
Link.
layout.footer_logo_height number
Height.
layout.footer_logo_margin number
Margin.
layout.footer_logo_order string
Position. Allowed values:
layout.footer_align_vertical string
V. align. Allowed values:
layout.footer_border string
Allowed values:
- top (Top)
- bottom (Bottom)
- 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:
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: