Cards
Updated 4 years ago to v4.0.4 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: 4
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: "4",
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: "4",
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
}
},
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: "4",
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: "4",
bindings: {
cards: {
title: "CardsHeader1",
image: "CardsHeader2",
category: "CardsHeader3",
subtitle: "CardsHeader4",
text: ["CardsHeader5", "CardsHeader6", ...],
}
},
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: "4",
data: {
cards: [
{
text: [...]
},
...
]
},
...
}
And the full list of all possible properties is as follows:
{
template: "@flourish/cards",
version: "4",
data: {
cards: [
{
title: ...,
image: ...,
category: ...,
subtitle: ...,
text: [...]
},
...
]
},
...
}
Meanings of the template data keys:
- cards.title: title
- cards.image: image
- cards.category: Optional category column to colour the cards
- cards.subtitle: subtitle
- cards.text: text
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_btn_visible boolean
Allowed values:
- true (On)
- false (Off)
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_padding_top number
Top.
card_padding_right number
Right.
card_padding_bottom number
Bottom.
card_padding_left number
Left.
card_space_between number
Space. Space between image and text
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
Customise card HTML.
template_simple_custom code
Refer to columns using `{{column_name}}`. Use handlebar syntax for conditions, etc. See handlebarsjs.com for more information.
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_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_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_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 % of the card's width
image_width_landscape number
Width. As a % 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 % of the card's width
image_vertical_margin number
Vertical. As a % of the card's width
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
Show blending.
image_contrast number
Contrast.
image_brightness number
Brightness.
image_saturation number
Saturation.
image_opacity number
Opacity. Max: 1
image_blend_mode string
Blend mode. Allowed values:
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 a 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 a column in your dataset Allowed values:
image_background_color_category color
Color.
colors.scale_type string
Scale type. Allowed values:
colors.categorical_type string
Allowed values:
- palette (Palette)
- generated (Generated)
colors.categorical_palette colors
Palette.
colors.categorical_extend boolean
Auto-extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once.
colors.categorical_seed_color color
Seed color. Initial color in generated sequence (avoid shades of grey).
colors.categorical_rotation_angle number
Hue rotation angle. Angle, in degrees, between one generated colour and the next. The default value, ~360/(Golden ratio), ensures adjacent hues are not too similar. Max: 360
colors.categorical_color_space string
Allowed values:
- hcl (HCL)
- hsl (HSL)
colors.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)
colors.sequential_palette string
Palette. Allowed values:
colors.sequential_custom_min color
Minimum color.
colors.sequential_custom_max color
Maximum color.
colors.sequential_color_space string
Allowed values:
- rgb (RGB)
- lab (LAB)
- hcl (HCL)
- hsl (HSL)
colors.sequential_reverse boolean
Reverse scale.
colors.diverging_palette string
Palette. Allowed values:
colors.diverging_custom_min color
Minimum color.
colors.diverging_custom_mid color
Midpoint color.
colors.diverging_custom_max color
Maximum color.
colors.diverging_color_space string
Allowed values:
- rgb (RGB)
- lab (LAB)
- hcl (HCL)
- hsl (HSL)
colors.diverging_reverse boolean
Reverse scale.
Legend
legend.show_legend boolean
Allowed values:
- true (Enabled)
- false (Disabled)
legend.text_color color
Color.
legend.text_size number
Size.
legend.title string
Title.
legend.title_weight string
Weight. Allowed values:
legend.swatch_width number
Width.
legend.swatch_height number
Height.
legend.swatch_radius number
Roundness. The radius of the corners of the swatch (in pixels)
legend.order_override text
Custom order override. Manually specify the order of legend entries (one entry per line)
legend.orientation string
Orientation. Allowed values:
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:
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.
Header
layout.header_align string
Alignment. Allowed values:
layout.title string
layout.title_styling boolean
Change title styles.
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. 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 string
layout.subtitle_styling boolean
Change subtitle styles.
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. 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 string
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. 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)
- 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
URL.
layout.header_logo_height number
Height.
layout.header_logo_align string
Align. Align logo inside header or outer visualisation 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.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:
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
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)
- 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