Word cloud

Visualize word frequencies in text

Updated 2 days ago to v3.8.4 by Flourish team

How to use this template

Word cloud template

A fun way to visualize the most common words in a piece of text.

Data requirements

You can supply your data either as raw text, or as a CSV or Excel spreadsheet of word frequencies.

To use raw text, just copy and paste your text into the Text setting.

To use a CSV or Excel spreadsheet of word frequencies, switch the Text input setting to Data sheet, and then upload your spreadsheet. It should have a column for words, and a column for their frequency.

Exclude common words

By default, the word cloud will not show the 100 most common words in English, like "the" and "if". If you do want to show these words, you can change this in the settings. You can also specify other words to exclude.

Credits

Layout algorithm by Jonathan Feinberg, implemented by Jason Davies.

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/word-cloud

version: 3

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: {
        words: [
            [ "WordsColumn1Value1", "WordsColumn2Value1",
            [ "WordsColumn1Value2", "WordsColumn2Value2",
            [ "WordsColumn1Value3", "WordsColumn2Value3",
            ...
        ]
    }
}

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/word-cloud",
    version: "3",
    bindings: {
        words: {
            word: 0, // index of a column in your data
        }
    },
    data: {
        words: [
            [ "WordsColumn1Value1", "WordsColumn2Value1",
            [ "WordsColumn1Value2", "WordsColumn2Value2",
            [ "WordsColumn1Value3", "WordsColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@flourish/word-cloud",
    version: "3",
    bindings: {
        words: {
            word: 0, // index of a column in your data
            value: 1, // index of a column in your data
            category: 2, // index of a column in your data
            metadata: [3, 4, ...], // index(es) of column(s) in your data
        }
    },
    data: {
        words: [
            [ "WordsColumn1Value1", "WordsColumn2Value1",
            [ "WordsColumn1Value2", "WordsColumn2Value2",
            [ "WordsColumn1Value3", "WordsColumn2Value3",
            ...
        ]
    }
}

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:

{
        words: [
            { "WordsHeader1": ..., "WordsHeader2": ..., ... },
            { "WordsHeader1": ..., "WordsHeader2": ..., ... },
            { "WordsHeader1": ..., "WordsHeader2": ..., ... },
            ...
        ]
    }

... 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/word-cloud",
    version: "3",
    bindings: {
        words: {
            word: "WordsHeader1",
        }
    },
    data: {
        words: [
            { "WordsHeader1": ..., "WordsHeader2": ..., ... },
            { "WordsHeader1": ..., "WordsHeader2": ..., ... },
            { "WordsHeader1": ..., "WordsHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/word-cloud",
    version: "3",
    bindings: {
        words: {
            word: "WordsHeader1",
            value: "WordsHeader2",
            category: "WordsHeader3",
            metadata: ["WordsHeader4", "WordsHeader5", ...],
        }
    },
    data: {
        words: [
            { "WordsHeader1": ..., "WordsHeader2": ..., ... },
            { "WordsHeader1": ..., "WordsHeader2": ..., ... },
            { "WordsHeader1": ..., "WordsHeader2": ..., ... },
            ...
        ]
    }
}

(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/word-cloud",
    version: "3",
    data: {
    words: [
        {
            word: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/word-cloud",
    version: "3",
    data: {
    words: [
        {
            word: ...,
            value: ...,
            category: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

  • words.word: word
  • words.value: value
  • words.category: category
  • words.metadata: Add any columns here containing extra content to show in the popups

Template settings

Options for opts.state.

Words

using_tables boolean

Text input. Pasting in raw text is simplest but may be slow for large amounts of text.

Allowed values:

  • false (Paste in raw text)
  • true (Datasheet)

word_limit number

Word limit. Limits the number of words, in order of frequency. Leave blank to show all words in the data table.

Min: 1

raw_text text

Text. Note that the raw text will be available in the hTML of the generated page.

exclusions boolean

Exclude common words.

excluded_words text

Exclude words.

strip_trailing_s boolean

Strip all trailing “'s” from words. e.g. "mother" and "mother's" are considered one word. This includes both apostrophe and quotation mark forms ('s and ’s).

convert_to_lowercase boolean

Convert all words to lowercase. e.g. "mother" and "Mother" are considered one word. This will also apply to the words in the "Exclude words" setting.

Cloud style

cloud_font font

Font.

text_color color

Text color.

word_padding number

Spacing. Spacing between the words (in arbitrary units)

random_seed number

Layout number. Change the number to try different word layouts.

angle_min number

Min angle.

Min: -180

Max: 180

angle_max number

Max angle.

Min: -180

Max: 180

angle_number number

Number of angles.

Min: 1

Max: 100

font_size_min number

Min size. In arbitrary units. Actual display size will depend in screen size and layout.

font_size_max number

Max size. In arbitrary units. Actual display size will depend in screen size and layout.

Min: 1

size_mode string

Scaling. This scale will determine the relationship in size between the biggest and the smallest word.

Allowed values:

  • linear (Linear)
  • sqrt (√)
  • log (Log)

height_mode string

Height mode. In “Fill space” mode the graphic will fill the container (which by default will be the the standard Flourish responsive chart size). In “Aspect ratio” mode you set the aspect ratio of the plot and the container will be updated to accommodate it (not supported when embedded in a simple fixed-height iframe).

Allowed values:

  • fill_space (Fill space)
  • aspect (Aspect ratio)

aspect_ratio number

Aspect (desktop). Aspect ratio of each plot in desktop mode, where 1 is square, above 1 is wider, and below 1 is taller.

Min: 0.01

Max: 100

aspect_ratio_mobile number

Aspect (mobile). Aspect ratio of each plot in desktop mode, where 1 is square, above 1 is wider, and below 1 is taller.

Min: 0.01

Max: 100

aspect_ratio_breakpoint number

Breakpoint. The width at which mobile mode ends and desktop begins

Colors

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. <br><br><a href="https://help.flourish.studio/article/458-how-to-customize-colors-in-flourish-palettes#:~:text=The%20main%20color%20tool%20in,delete%20and%20add%20new%20colors">Colors can be set</a> using Hex, RGB, color names or RGBA, if you want to set the <a href="https://help.flourish.studio/article/393-add-transparency-to-flourish-colors">opacity</a>. Multiple colors can be set using multiple lines. For example: <br /><hr />Party 1: red <br />Party 2: #4455AA <br />Party 3: rgb(30,168,26)

color.numeric_type string

Scale type.

Allowed values:

  • sequential (Sequential)
  • diverging (Diverging)

color.binning boolean

In <b>linear</b> mode, the color scale will run as a smooth gradient between 2 colors. In <b>binned</b> mode, the gradient will be divided in smaller blocks.

Allowed values:

  • false (Linear)
  • true (Binned)

color.bin_mode string

Binning mode.

Allowed values:

  • fixed (Fixed width)
  • quantile (Quantile)
  • custom (Custom thresholds)

color.bin_count number

Number of bins.

color.bin_thresholds string

Custom thresholds. Enter your desired thresholds, separating them with a ";". For instance, "5;10;15". <br><br>Bins form as follows: <ul> <li>From the data's minimum value (domain minimum) up to the first threshold.</li> <li>Between consecutive thresholds.</li> <li>From the last threshold to the data's maximum value (domain maximum).</li> <ul> </br>For "5;10;15", you'll get four bins based on your data's range.

color.sequential_palette string

Palette.

Allowed values:

  • Oranges (Oranges)
  • Reds (Reds)
  • Blues (Blues)
  • Greens (Greens)
  • Greys (Greys)
  • Purples (Purples)
  • Viridis (Viridis)
  • Inferno (Inferno)
  • Magma (Magma)
  • Plasma (Plasma)
  • Warm (Warm)
  • Cool (Cool)
  • CubehelixDefault (Cubehelix)
  • BuGn (Blue/Green)
  • BuPu (Blue/Purple)
  • GnBu (Green/Blue)
  • OrRd (Orange/Red)
  • PuBuGn (Purple/Blue/Green)
  • PuBu (Purple/Blue)
  • PuRd (Purple/Red)
  • RdPu (Red/Purple)
  • YlGnBu (Yellow/Blue/Green)
  • YlGn (Yellow/Green)
  • YlOrBr (Yellow/Orange/Brown)
  • YlOrRd (Yellow/Orange/Red)
  • Carrots
  • Custom

color.sequential_reverse boolean

Reverse.

color.sequential_custom_min color

Minimum color.

color.sequential_custom_max color

Maximum color.

color.sequential_color_space string

Color space.

Allowed values:

  • rgb (RGB)
  • lab (LAB)
  • hcl (HCL)
  • hsl (HSL)

color.sequential_custom_domain boolean

Domain.

Allowed values:

  • false (Auto)
  • true (Custom)

color.sequential_domain_min number

Min.

color.sequential_domain_max number

Max.

color.diverging_palette string

Palette.

Allowed values:

  • RdBu (Red/Blue)
  • RdYlGn (Red/Yellow/Green)
  • PiYG (Pink/Yellow/Green)
  • BrBG (Brown/Blue/Green)
  • PRGn (Purple/Red/Green)
  • PuOr (Purple/Orange)
  • RdGy (Red/Grey)
  • RdYlBu (Red/Yellow/Blue)
  • Spectral (Spectral)
  • Custom

color.diverging_reverse boolean

Reverse.

color.diverging_custom_min color

Minimum color.

color.diverging_custom_mid color

Midpoint color.

color.diverging_custom_max color

Maximum color.

color.diverging_color_space string

Color space.

Allowed values:

  • rgb (RGB)
  • lab (LAB)
  • hcl (HCL)
  • hsl (HSL)

color.diverging_custom_domain boolean

Domain.

Allowed values:

  • false (Auto)
  • true (Custom)

color.diverging_domain_min number

Min.

color.diverging_domain_mid number

Mid.

color.diverging_domain_max number

Max.

Animation

animation_type string

Animation style. Controls the animation on load. “Auto” mode will use “Grow” if there are fewer than 100 words visible, “Fade” if there are fewer than 500, and “None” if there are 500 or more.

Allowed values:

  • auto (Auto)
  • fade (Fade)
  • grow (Grow)
  • none (None)

duration number

Duration. The time in seconds it takes for an individual word to move from start position to end position.

stagger number

Stagger. The time in seconds between the first and last word animations starting.

Max: 5

Number formatting

number_format.prefix string

Prefix. Text to place in front of number

number_format.suffix string

Suffix. <a href="https://help.flourish.studio/article/37-how-to-change-number-formating">Text</a> to place after number

number_format.n_dec number

Decimal places. Enter a negative integer to <a href="https://help.flourish.studio/article/37-how-to-change-number-formating#multiply-divide">round to a whole number<a/> with that many zeros. For example, -2 will round to the nearest hundred.

Min: -10

Max: 10

number_format.advanced boolean

Advanced.

number_format.negative_sign string

Styling of negative numbers.

Allowed values:

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

number_format.strip_zeros boolean

Remove trailing zeros.

number_format.strip_separator boolean

Hide thousands separator below 10,000. Turn off if you want four-digit numbers to include a separator, e.g. “1,234” rather than “1234”.

number_format.transform_labels boolean

Multiply/divide values.

number_format.transform string

Allowed values:

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

number_format.multiply_divide_constant number

number_format.exponentiate_constant number

localization.input_decimal_separator string

Decimal separator in data sheet. Used for interpreting your data. Only change if data is not displaying on the chart as expected.

Allowed values:

  • . (.)
  • , (,)

localization.output_separators string

Number format to display. How the numbers should appear on chart labels

Allowed values:

  • ,. (12,235.67)
  • ., (12.345,67)
  • . (12235.67)
  • , (12345,67)
  • . (12 235.67)
  • , (12 345,67)

Popups & panels

popup.mode string

Allowed values:

  • none (None)
  • popup (Popup)
  • panel (Panel)
  • both (Both)

popup.popup_is_custom boolean

Popup content.

Allowed values:

  • false (Auto)
  • true (Custom)

popup.show_popup_styles boolean

Show popup styles.

popup.popup_custom_header html

Popup custom header. Use {{column_name}} to add a <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups">value from your data</a>. Ensure the column is selected, or add it to <b>Info for popups</b> for popup use. <br><br>Advanced users can add <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups#html">HTML</a> styling or <a href="https://help.flourish.studio/article/438-how-to-add-category-colors-to-popup-headers">add category colors</a> to popup headers. <br><br>To <a href="https://help.flourish.studio/article/490-how-to-add-conditional-statements-to-your-popups">hide parts of the popup</a> when a column is empty using <pre>{{#if column_name}}Content for non-empty column_name{{/if}}.</pre> For example: <pre>{{#if Capital name}}Capital:{{/if}} {{Capital name}}.</pre> 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 <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups">value from your data</a>. Ensure the column is selected, or add it to <b>Info for popups</b> for popup use. <br><br>Advanced users can add <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups#html">HTML</a> for designs, styles, and images. <br><br>To<a href="https://help.flourish.studio/article/490-how-to-add-conditional-statements-to-your-popups"> hide parts of the popup</a> when a column is empty use the syntax <pre>{{#if column_name}}Content for non-empty column_name{{/if}}.</pre> For example: <pre>{{#if Capital name}}Capital:{{/if}} {{Capital name}}.</pre> 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 <code>aria-label</code> attribute to data point elements. You can still use {{column_name}} to add values from your data, but do not use HTML. For example: <code>{Name}}, Population: {{Population}}, GDP: {{GDP}}</code> If left empty, accessible content will fallback to the default popup content.

popup.popup_width number

Max width. In <a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">rems</a>, multiples of base font size. Leave blank to let the width adjust based on the contents.

popup.popup_font_size number

Text size.

popup.popup_text_color color

Text color.

popup.popup_align string

Align.

Allowed values:

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

popup.popup_background color

Fill color.

popup.popup_background_opacity number

Fill opacity.

Max: 1

popup.popup_padding number

Padding.

popup.popup_radius number

Radius. Corner radius of popup

popup.popup_header_type string

Header style.

Allowed values:

  • block (Header block)
  • inline (Header inline)

popup.popup_header_background color

Background.

popup.popup_header_text_color color

Text.

popup.popup_list_type string

List type.

Allowed values:

  • table (fa-table)
  • ul (fa-list)

popup.popup_list_label_weight string

Label weight.

Allowed values:

  • normal (Normal)
  • bold (Bold)

popup.popup_list_separator string

List separator.

Predefined values:

  • : (:)
  • (–)
  • (Empty space)
  • <br /> (Line break)

popup.popup_shadow boolean

Shadow.

popup.popup_pointer boolean

Pointer.

popup.panel_position string

Allowed values:

  • overlay (Overlay)
  • left (Left)
  • right (Right)
  • top (Top)
  • bottom (Bottom)

popup.panel_open_duration number

Open duration.

Max: 2000

popup.panel_side_fixed boolean

Always show.

popup.panel_side_default_content text

Placeholder content.

popup.panel_is_custom boolean

Panel content.

Allowed values:

  • false (Auto)
  • true (Custom)

popup.show_panel_styles boolean

Show panel styles.

popup.panel_custom_header html

Panel custom header. Use {{column_name}} to add a <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups">value from your data</a>. Ensure the column is selected, or add it to <b>Info for popups</b> for panel use. <br><br>Advanced users can add <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups#html">HTML</a> for styling or <a href="https://help.flourish.studio/article/438-how-to-add-category-colors-to-popup-headers">add category colors</a> to panel headers. <br><br>To <a href="https://help.flourish.studio/article/490-how-to-add-conditional-statements-to-your-popups">hide parts of the panel</a> when a column is empty using <pre>{{#if column_name}}Content for non-empty column_name{{/if}}.</pre> For example: <pre>{{#if Capital name}}Capital:{{/if}} {{Capital name}}.</pre> 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 <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups">value from your data</a>. Ensure the column is selected, or add it to <b>Info for popups</b> for panel use. <br><br>Advanced users can add <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups#html">HTML</a> for designs, styles, <a href="https://help.flourish.studio/article/437-how-to-add-images-to-your-popups-and-panels">images, videos and <a href="https://help.flourish.studio/article/259-how-to-embed-charts-in-your-popups-or-panels#embedding-charts-in-your-popups">embedded Flourish charts</a>, <br><br>To <a href="https://help.flourish.studio/article/490-how-to-add-conditional-statements-to-your-popups">hide parts of the panel</a> when a column is empty using <pre>{{#if column_name}}Content for non-empty column_name{{/if}}.</pre> For example: <pre>{{#if Capital name}}Capital:{{/if}} {{Capital name}}.</pre> 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 <b>Click position</b> is especially useful when your visualization is really tall, this will make sure the panel content is always on top of the element you've clicked on

Allowed values:

  • click (Click position)
  • center (Center)

popup.panel_text_color color

Text color.

popup.panel_font_size number

Text size.

popup.panel_align string

Alignment.

Allowed values:

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

popup.panel_background color

Fill color.

popup.panel_background_opacity number

Fill opacity.

Max: 1

popup.panel_padding number

Padding.

popup.panel_radius number

Radius. Corner radius of panel

popup.panel_list_type string

List type.

Allowed values:

  • table (fa-table)
  • ul (fa-list)

popup.panel_list_label_weight string

Label weight.

Allowed values:

  • normal (Normal)
  • bold (Bold)

popup.panel_list_separator string

List separator.

Predefined values:

  • : (:)
  • (–)
  • (Empty space)
  • <br /> (Line break)

popup.panel_shadow boolean

Shadow.

Layout

layout.body_font font

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

layout.font_color color

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

layout.background_color_enabled boolean

Color.

Allowed values:

  • true (On)
  • false (Off)

layout.background_image_enabled boolean

Image.

Allowed values:

  • true (On)
  • false (Off)

layout.background_color color

Background color.

layout.background_image_src url

Image URL.

layout.background_image_size string

Size.

Allowed values:

  • cover (Fill)
  • contain (Fit)
  • auto (Original)
  • 100% 100% (Stretch)

layout.background_image_position string

Position.

Allowed values:

  • top left (Top left)
  • top center (Top center)
  • top right (Top right)
  • center left (Center left)
  • center center (Center)
  • center right (Center right)
  • bottom left (Bottom left)
  • bottom center (Bottom center)
  • bottom right (Bottom right)

layout.max_width_target string

Maximum width. Apply a <a href="https://help.flourish.studio/article/270-how-to-embed-a-visualization-with-a-maximum-width">maximum width</a> to just the <b>main graphic</b> or <b>everything</b> (main graphic plus header, footer, etc).

Allowed values:

  • none (None)
  • wrapper (Everything)
  • primary (Main graphic)

layout.max_width number

Maximum width. Leave blank to stretch to container width

Min: 50

layout.max_width_align string

Align.

Allowed values:

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

layout.layout_order string

Layout order.

Allowed values:

  • stack-default (Header – controls – legend – primary graphic – footer)
  • stack-2 (Primary graphic – header – controls – legend – footer)
  • stack-3 (Header – primary graphic – controls – legend – footer)
  • stack-4 (Controls – primary graphic – header – controls – legend – footer)
  • grid-1 (Grid mode: Primary graphic on the right)

layout.space_between_sections string

Space between sections.

Allowed values:

  • 0.5 (▁)
  • 1 (▃)
  • 1.5 (▄)
  • custom (...)

layout.space_between_sections_custom number

Custom.

Max: 100

layout.margin_top number

Top.

layout.margin_right number

Right.

layout.margin_bottom number

Bottom.

layout.margin_left number

Left.

layout.border.enabled boolean

Show borders around visualisation.

layout.border.top.width number

Top.

layout.border.top.style string

Style.

Allowed values:

  • solid (Solid)
  • dashed (Dashed)
  • dotted (Dotted)

layout.border.top.color color

Color.

layout.border.right.width number

Right.

layout.border.right.style string

Style.

Allowed values:

  • solid (Solid)
  • dashed (Dashed)
  • dotted (Dotted)

layout.border.right.color color

Color.

layout.border.bottom.width number

Bottom.

layout.border.bottom.style string

Style.

Allowed values:

  • solid (Solid)
  • dashed (Dashed)
  • dotted (Dotted)

layout.border.bottom.color color

Color.

layout.border.left.width number

Left.

layout.border.left.style string

Style.

Allowed values:

  • solid (Solid)
  • dashed (Dashed)
  • dotted (Dotted)

layout.border.left.color color

Color.

layout.read_direction string

Read direction. This will change the reading direction of the main text elements on the page. It's not possible to adjust this on all elements, such as axes. <br><br>Note that when direction is set to <b>right to left</b> any alignment icons will be reversed.

Allowed values:

  • ltr (Left to right)
  • rtl (Right to left)

layout.font_size_mobile_small number

layout.font_size_mobile_big number

layout.font_size_tablet number

layout.font_size_desktop number

layout.font_size_big_screen number

layout.breakpoint_mobile_small number

layout.breakpoint_mobile_big number

layout.breakpoint_tablet number

layout.breakpoint_desktop number

layout.breakpoint_big_screen number

layout.header_align string

Alignment.

Allowed values:

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

layout.title html

layout.title_styling boolean

Styling.

layout.title_font font

Title Font.

layout.title_size string

Size.

Allowed values:

  • 1.4 (ᴀ)
  • 1.6 (A)
  • 2 (fa-font)
  • custom (...)

layout.title_size_custom number

Custom. Specify a custom responsive font size in <a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">rems</a>. The best results will be with values between 1.2 and 3

layout.title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.title_color color

Color.

layout.title_line_height number

Line height.

Max: 3

layout.title_space_above string

Space above.

Allowed values:

  • 0 (▁)
  • 0.5 (▃)
  • 1 (▄)
  • custom (...)

layout.title_space_above_custom number

Custom.

Max: 100

layout.subtitle html

layout.subtitle_styling boolean

Styling.

layout.subtitle_font font

Subtitle Font.

layout.subtitle_size string

Size.

Allowed values:

  • 1.4 (ᴀ)
  • 1.6 (A)
  • 2 (fa-font)
  • custom (...)

layout.subtitle_size_custom number

Custom. Specify a custom responsive font size in <a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">rems</a>. The best results will be with values between 1.2 and 3

layout.subtitle_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.subtitle_color color

Color.

layout.subtitle_line_height number

Line height.

Max: 3

layout.subtitle_space_above string

Space above.

Allowed values:

  • 0 (▁)
  • 0.5 (▃)
  • 1 (▄)
  • custom (...)

layout.subtitle_space_above_custom number

Custom.

Max: 100

layout.header_text html

layout.header_text_styling boolean

Styling.

layout.header_text_size string

Size.

Allowed values:

  • 1.2 (ᴀ)
  • 1.4 (A)
  • 1.6 (fa-font)
  • custom (...)

layout.header_text_size_custom number

Custom. Specify a custom responsive font size in <a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">rems</a>. The best results will be with values between 1.2 and 3

layout.header_text_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.header_text_color color

Color.

layout.header_text_line_height number

Line height.

Max: 3

layout.header_text_space_above string

Space above.

Allowed values:

  • 0 (▁)
  • 0.5 (▃)
  • 1 (▄)
  • custom (...)

layout.header_text_space_above_custom number

Custom.

Max: 100

layout.header_border string

Allowed values:

  • top (Top)
  • bottom (Bottom)
  • top_and_bottom (Top & bottom)
  • none (None)

layout.header_border_width number

Width.

layout.header_border_color color

Color.

layout.header_border_style string

Style.

Allowed values:

  • solid (Solid)
  • dashed (Dashed)
  • dotted (Dotted)

layout.header_border_space number

Space. Space between border and header text

layout.header_logo_enabled boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

layout.header_logo_src url

Image.

layout.header_logo_alt string

Alt text.

Link.

layout.header_logo_height number

Height.

layout.header_logo_align string

Align. Align logo inside either the header or the main visualization container

Allowed values:

  • inside (Header)
  • outside (Main container)

layout.header_logo_position_inside string

Position.

Allowed values:

  • top (Top)
  • left (Left)
  • right (Right)

layout.header_logo_position_outside string

Position.

Allowed values:

  • left (Left)
  • right (Right)

layout.header_logo_margin_top number

Top.

layout.header_logo_margin_right number

Right.

layout.header_logo_margin_bottom number

Bottom.

layout.header_logo_margin_left number

Left.

layout.footer_align string

Alignment.

Allowed values:

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

layout.footer_text_size number

Size.

layout.footer_text_color color

Color.

layout.footer_styling boolean

Advanced footer styles.

layout.footer_font font

Font.

layout.footer_text_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.source_name string

Source name.

layout.source_url string

Source url.

layout.multiple_sources boolean

Multiple sources.

layout.source_name_2 string

Source name.

layout.source_url_2 string

Source url.

layout.source_name_3 string

Source name.

layout.source_url_3 string

Source url.

layout.source_label string

Source label.

layout.footer_note html

Note.

layout.footer_note_secondary html

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

layout.footer_logo_enabled boolean

Image.

Allowed values:

  • true (Enabled)
  • false (Disabled)

layout.footer_logo_src url

Image.

layout.footer_logo_src_light hidden

Image (light version). If provided this version will be used whenever the background color is dark

layout.footer_logo_alt string

Alt text.

Link.

layout.footer_logo_height number

Height.

layout.footer_logo_margin number

Margin.

layout.footer_logo_order string

Position.

Allowed values:

  • left (Left)
  • right (Right)

layout.footer_align_vertical string

V. align.

Allowed values:

  • flex-start (Top)
  • center (Center)
  • flex-end (Bottom)

layout.footer_border string

Allowed values:

  • top (Top)
  • bottom (Bottom)
  • top_and_bottom (Top & bottom)
  • none (None)

layout.footer_border_width number

Width.

layout.footer_border_color color

Color.

layout.footer_border_style string

Style.

Allowed values:

  • solid (Solid)
  • dashed (Dashed)
  • dotted (Dotted)

layout.footer_border_space number

Space. Space between border and footer text

Accessibility

layout.screenreader_text_primary text

Screenreader description. A text alternative to the visual content that will only be visible to <a href="https://help.flourish.studio/article/230-how-to-add-a-screenreader-description">screenreaders</a>, e.g. “The line chart shows China consistently higher than the other countries since 1990”. <br><br>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 <a href="https://help.flourish.studio/article/230-how-to-add-a-screenreader-description">screenreaders</a>. 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 <a href="https://help.flourish.studio/article/230-how-to-add-a-screenreader-description">screenreaders</a>. (Text in the header and footer are always available to screenreaders.)

Allowed values:

  • true (Hidden)
  • false (Readable)