Cards
Updated a month ago to v11.1.5 by Flourish team
How to use this template
Cards
Use this template to visualize blocks of content in a cards grid or carousel. Each row in the dataset represents a card.
Features
View
- View mode: You can choose between two different view modes: "Grid" which wraps cards in columns and rows and "Carousel" which creates a slideshow to cycle through cards.
- Autoplay: you can autoplay your cards on a loop (only available on carousel mode)
Cards
- Card layout: you can choose between three different layout options: “Portrait”, “Landscape”, and “Image overlay”. If "Portrait" layout is selected, you also have the option to structure you card content in the "Card structure" dropdown.
- Customize your cards: By clicking on "customize card HTML", you can have full control over the card layout, write your own HTML, and customize your cards however you want them to be.
Text
- Column names: By default, column names are being added to each text entry. Under the Advanced settings of Text, you can turn this feature off and change the type of separator between column names and text entries in the column separator dropdown.
Images
How do you add/change the filter on images? Under the Image tab, you can change the filter applied to images by clicking on “Show blending”. You will be presented with different styling settings, such as contrast, brightness, saturation, and opacity. You will also get a blend mode dropdown, in which you’ll be able to choose the blend mode that will be applied to your images. By default, the blend mode is “Normal”, which resets the image to its original appearance. To choose the color of your filter, go to the Colors tab.
In the case of missing images in the dataset, what are my options? If you have missing images in your dataset, but do not want text-only cards, there is an option to add an icon of your choice in place of all missing images in your dataset. To do so, go to the Image tab and switch to Icon under missing images. A link uploader will appear for you to download your own icon.
Colors
- Color by data: In the Colors tab, you can select the background color of your cards and the filter color of your images. The “Data” option, which colors cards/images by category, is only possible if your “Categories” data binding is on.
Legend
- Interactive legend: If the “Categories” data binding is on, you have the option of adding a legend to the template. You can filter out specific cards by clicking on one of the categories within the legend.
Credits
Created by the Flourish team. 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/cards
version: 11
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: {
cards: [
[ "CardsColumn1Value1", "CardsColumn2Value1",
[ "CardsColumn1Value2", "CardsColumn2Value2",
[ "CardsColumn1Value3", "CardsColumn2Value3",
...
]
}
}
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/cards",
version: "11",
bindings: {
cards: {
}
},
data: {
cards: [
[ "CardsColumn1Value1", "CardsColumn2Value1",
[ "CardsColumn1Value2", "CardsColumn2Value2",
[ "CardsColumn1Value3", "CardsColumn2Value3",
...
]
}
}
All possible bindings that you can supply are shown in this example:
{
template: "@flourish/cards",
version: "11",
bindings: {
cards: {
title: 0, // index of a column in your data
image: 1, // index of a column in your data
category: 2, // index of a column in your data
subtitle: 3, // index of a column in your data
text: [4, 5, ...], // index(es) of column(s) in your data
audio: 6, // index of a column in your data
filter: 7, // index of a column in your data
metadata: [8, 9, ...], // index(es) of column(s) in your data
}
},
data: {
cards: [
[ "CardsColumn1Value1", "CardsColumn2Value1",
[ "CardsColumn1Value2", "CardsColumn2Value2",
[ "CardsColumn1Value3", "CardsColumn2Value3",
...
]
}
}
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:
{
cards: [
{ "CardsHeader1": ..., "CardsHeader2": ..., ... },
{ "CardsHeader1": ..., "CardsHeader2": ..., ... },
{ "CardsHeader1": ..., "CardsHeader2": ..., ... },
...
]
}
... 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/cards",
version: "11",
bindings: {
cards: {
}
},
data: {
cards: [
{ "CardsHeader1": ..., "CardsHeader2": ..., ... },
{ "CardsHeader1": ..., "CardsHeader2": ..., ... },
{ "CardsHeader1": ..., "CardsHeader2": ..., ... },
...
]
}
}
All possible bindings that you can supply are shown in this example:
{
template: "@flourish/cards",
version: "11",
bindings: {
cards: {
title: "CardsHeader1",
image: "CardsHeader2",
category: "CardsHeader3",
subtitle: "CardsHeader4",
text: ["CardsHeader5", "CardsHeader6", ...],
audio: "CardsHeader7",
filter: "CardsHeader8",
metadata: ["CardsHeader9", "CardsHeader10", ...],
}
},
data: {
cards: [
{ "CardsHeader1": ..., "CardsHeader2": ..., ... },
{ "CardsHeader1": ..., "CardsHeader2": ..., ... },
{ "CardsHeader1": ..., "CardsHeader2": ..., ... },
...
]
}
}
(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/cards",
version: "11",
data: {
cards: [
{
text: [...],
metadata: [...]
},
...
]
},
...
}
And the full list of all possible properties is as follows:
{
template: "@flourish/cards",
version: "11",
data: {
cards: [
{
title: ...,
image: ...,
category: ...,
subtitle: ...,
text: [...],
audio: ...,
filter: ...,
metadata: [...]
},
...
]
},
...
}
Meanings of the template data keys:
- cards.title: title string
- cards.image: image string
- cards.category: Optional category column to color the cards string
- cards.subtitle: subtitle string
- cards.text: text string
- cards.audio: Add an audio file to the card, which will play when the card is clicked. This will disable popup behavior. string
- cards.filter: filter string, number, datetime
- cards.metadata: One or more columns of information (text, <a href="https://help.flourish.studio/article/46-how-to-add-images-to-your-visualization">image URLs</a>, <a href="https://help.flourish.studio/article/259-how-to-embed-charts-in-your-popups-or-panels">embedded charts</a> etc) to include in <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups">custom 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/cards",
version: "11",
...
data: {
cards: [
[ "CardsColumn1Value1", "CardsColumn2Value1",
[ "CardsColumn1Value2", "CardsColumn2Value2",
[ "CardsColumn1Value3", "CardsColumn2Value3",
...
]
},
metadata: {
cards: {
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/cards",
version: "11",
data: {
cards: [
{ "CardsHeader1": ..., "CardsHeader2": ..., ... },
{ "CardsHeader1": ..., "CardsHeader2": ..., ... },
{ "CardsHeader1": ..., "CardsHeader2": ..., ... },
...
]
},
metadata: {
cards: {
"CardsHeader1": { type: ..., type_id: ..., output_format_id: ... },
"CardsHeader2": { 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.
View
mode string
View mode. Allowed values:
carousel_channel_background color
Channel color.
carousel_bar_background color
Bar color.
carousel_channel_height number
Channel height. Min: 1
autoplay_enabled boolean
Allowed values:
- true (On)
- false (Off)
autoplay_duration number
Duration.
autoplay_loop boolean
Loop.
autoplay_pause_when string
Pause on interaction. Allowed values:
autoplay_btn_visible boolean
Allowed values:
- true (On)
- false (Off)
autoplay_btn_position string
Position. Allowed values:
autoplay_btn_size number
Size.
autoplay_btn_background color
Background.
autoplay_btn_opacity number
Opacity.
autoplay_btn_color color
Icon.
Cards
card_layout string
Card layout. Allowed values:
card_order string
Card structure. Allowed values:
card_width_portrait number
Width.
card_width_landscape number
Width.
card_width_stretch boolean
Stretch cards to fill.
card_width_stretch_percent number
Stretch. How much the cards are allowed to scale up to fill the space, in %. When too much stretch would be required, cards are scaled down to add a column to the grid.
card_padding_top number
Top.
card_padding_right number
Right.
card_padding_bottom number
Bottom.
card_padding_left number
Left.
card_horizontal_margin number
Horizontal.
card_vertical_margin number
Vertical.
card_border_color color
Border color.
card_border_width number
Weight.
card_shape string
Shape. Allowed values:
card_radius number
Roundness. Max: 100
card_shadow boolean
Shadow behind card. Allowed values:
card_shadow_color color
Color.
card_shadow_blur number
Blur.
template_customise boolean
Customize card HTML.
template_simple_custom html
Custom HTML. Custom HTML can be used for flippable cards, text on hover, embedded Flourish charts, etc.
Refer to columns using {{column_name}}. If a column name has spaces, wrap in square brackets, like {{[column name]}}.
If a column includes HTML, prevent escaping HTML by wrapping in triple curly brackets. For example: {{{column_name}}}.
Use handlebar syntax for conditions, etc.
Text
content_vertical_align string
Vertical position. Allowed values:
content_horizontal_padding number
Horizontal space.
title_color color
Color.
title_fontsize number
Font size.
title_weight string
Weight. Allowed values:
title_advanced boolean
Advanced settings.
title_opacity number
Opacity. Max: 1
title_space_above number
Space above.
title_space_below number
Space below.
title_lineheight number
Line height.
title_minheight number
Min height.
title_align string
Align. Allowed values:
subtitle_color color
Color.
subtitle_fontsize number
Font size.
subtitle_weight string
Weight. Allowed values:
subtitle_advanced boolean
Advanced settings.
subtitle_opacity number
Opacity. Max: 1
subtitle_space_above number
Space above.
subtitle_space_below number
Space below.
subtitle_lineheight number
Line height.
subtitle_minheight number
Min height.
subtitle_align string
Align. Allowed values:
text_color color
Color.
text_fontsize number
Font size.
text_weight string
Weight. Allowed values:
text_advanced boolean
Advanced settings.
text_opacity number
Opacity. Max: 1
text_space_between number
Space between.
text_lineheight number
Line height.
text_minheight number
Min height.
text_align string
Align. Allowed values:
text_column_names boolean
Column names. To add column names before text entries Allowed values:
text_column_separator string
Column separator. Choose a separator between column names and text entries Allowed values:
text_column_weight string
Weight. Allowed values:
text_column_separator_custom string
Other.
Image
image_width_portrait number
Width. As a percentage of the card's width
image_width_landscape number
Width. As a percentage of the card's width
image_aspect_ratio number
Aspect ratio. As a multiplier of the image's width. For example: a value of 2, means the image height is 2 times the image width
image_sizing string
Image sizing. Allowed values:
image_horizontal_margin number
Horizontal. As a percentage of the card's width
image_vertical_margin number
Vertical. As a percentage of the card's width
card_space_between number
Space between image and text.
image_border_color color
Color.
image_border_width number
Weight.
image_shape string
Shape. Allowed values:
image_radius number
Roundness. Max: 100
image_styling boolean
Advanced image styling.
image_opacity number
Opacity. Max: 1
image_contrast number
Contrast. Max: 100
image_brightness number
Brightness. Max: 100
image_blend_mode string
Blend mode. Allowed values:
image_blackwhite boolean
Black and white.
image_missing string
Missing images. What to show when there's a missing image Allowed values:
image_missing_icon url
Missing icon.
Colors
card_background_mode string
Card. Allowed values:
card_background_color color
Color.
card_background_mode_category string
Card. Choose Data if you want to base the color on the 'Categories' column in your dataset Allowed values:
card_background_color_category color
Color.
image_background_mode string
Image. Allowed values:
image_background_color color
Color.
image_background_mode_category string
Image. Choose Data if you want to base the color on the 'Categories' column in your dataset Allowed values:
image_background_color_category color
Color.
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.
Popups & panels
popups.mode string
Allowed values:
- none (None)
- popup (Popup)
- panel (Panel)
- both (Both)
popups.popup_is_custom boolean
Popup content. Allowed values:
popups.show_popup_styles boolean
Show popup styles.
popups.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.
popups.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.
popups.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.
popups.popup_width number
Max width. In rems, multiples of base font size. Leave blank to let the width adjust based on the contents.
popups.popup_font_size number
Text size.
popups.popup_text_color color
Text color.
popups.popup_align string
Align. Allowed values:
popups.popup_background color
Fill color.
popups.popup_background_opacity number
Fill opacity. Max: 1
popups.popup_padding number
Padding.
popups.popup_radius number
Radius. Corner radius of popup
popups.popup_header_type string
Header style. Allowed values:
popups.popup_header_background color
Background.
popups.popup_header_text_color color
Text.
popups.popup_list_type string
List type. Allowed values:
popups.popup_list_label_weight string
Label weight. Allowed values:
popups.popup_list_separator string
List separator. Predefined values:
popups.popup_shadow boolean
Shadow.
popups.popup_pointer boolean
Pointer.
popups.panel_position string
Allowed values:
- overlay (Overlay)
- left (Left)
- right (Right)
- top (Top)
- bottom (Bottom)
popups.panel_open_duration number
Open duration. Max: 2000
popups.panel_side_fixed boolean
Always show.
popups.panel_side_default_content text
Placeholder content.
popups.panel_is_custom boolean
Panel content. Allowed values:
popups.show_panel_styles boolean
Show panel styles.
popups.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.
popups.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.
popups.panel_width_overlay number
Width (%).
popups.panel_height_overlay number
Height (%).
popups.panel_width_side number
Width (%).
popups.panel_height_side number
Height (%).
popups.panel_max_width number
Max width (px).
popups.panel_max_height number
Max height (px).
popups.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:
popups.panel_text_color color
Text color.
popups.panel_font_size number
Text size.
popups.panel_align string
Alignment. Allowed values:
popups.panel_background color
Fill color.
popups.panel_background_opacity number
Fill opacity. Max: 1
popups.panel_padding number
Padding.
popups.panel_radius number
Radius. Corner radius of panel
popups.panel_list_type string
List type. Allowed values:
popups.panel_list_label_weight string
Label weight. Allowed values:
popups.panel_list_separator string
List separator. Predefined values:
popups.panel_shadow boolean
Shadow.
Legend
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
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_filter_mode string
Filter on click. Allowed values:
Controls
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_controls.control_type string
Control type. Choose between a dropdown, buttons or a time slider. Allowed values:
filter_controls.control_styles boolean
Adv..
filter_controls.control_title string
Control title.
filter_controls.button_group boolean
Grouped. Allowed values:
filter_controls.button_group_width_mode string
Button group width. Allowed values:
filter_controls.button_group_width_fixed number
Width. Max: 100
filter_controls.dropdown_width_mode string
Dropdown width. Allowed values:
filter_controls.dropdown_width_fixed number
Width. Max: 100
filter_controls.slider_width number
Slider width. Width of the slider track in rems Max: 100
filter_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
filter_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
filter_controls.slider_loop boolean
Loop.
filter_controls.slider_restart_pause number
Pause before loop. Measured in seconds and in addition to the regular step time displayed above Max: 100
filter_controls.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.
Audio
audio_click string
Click while playing should:. Allowed values:
audio_animation boolean
Animate while playing audio.
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:
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:
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.
