3D globe
Updated 5 months ago to v1.7.2 by Flourish team
How to use this template
3D globe
Convey complex spatiotemporal information in a visually engaging way
Credits
The default data and Animated starting point show data on earthquakes from NOAA. The color and size starting point shows data on world cities from SimpleMaps.
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/globe
version: 1
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: { points: [ [ "PointsColumn1Value1", "PointsColumn2Value1", [ "PointsColumn1Value2", "PointsColumn2Value2", [ "PointsColumn1Value3", "PointsColumn2Value3", ... ] } }
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/globe", version: "1", bindings: { points: { lat: 1, // index of a column in your data lng: 2, // index of a column in your data } }, data: { points: [ [ "PointsColumn1Value1", "PointsColumn2Value1", [ "PointsColumn1Value2", "PointsColumn2Value2", [ "PointsColumn1Value3", "PointsColumn2Value3", ... ] } }
All possible bindings that you can supply are shown in this example:
{ template: "@flourish/globe", version: "1", bindings: { points: { name: 0, // index of a column in your data lat: 1, // index of a column in your data lng: 2, // index of a column in your data radius: 3, // index of a column in your data color: 4, // index of a column in your data start_time: 5, // index of a column in your data end_time: 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: { points: [ [ "PointsColumn1Value1", "PointsColumn2Value1", [ "PointsColumn1Value2", "PointsColumn2Value2", [ "PointsColumn1Value3", "PointsColumn2Value3", ... ] } }
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:
{ points: [ { "PointsHeader1": ..., "PointsHeader2": ..., ... }, { "PointsHeader1": ..., "PointsHeader2": ..., ... }, { "PointsHeader1": ..., "PointsHeader2": ..., ... }, ... ] }
... 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/globe", version: "1", bindings: { points: { lat: "PointsHeader2", lng: "PointsHeader3", } }, data: { points: [ { "PointsHeader1": ..., "PointsHeader2": ..., ... }, { "PointsHeader1": ..., "PointsHeader2": ..., ... }, { "PointsHeader1": ..., "PointsHeader2": ..., ... }, ... ] } }
All possible bindings that you can supply are shown in this example:
{ template: "@flourish/globe", version: "1", bindings: { points: { name: "PointsHeader1", lat: "PointsHeader2", lng: "PointsHeader3", radius: "PointsHeader4", color: "PointsHeader5", start_time: "PointsHeader6", end_time: "PointsHeader7", filter: "PointsHeader8", metadata: ["PointsHeader9", "PointsHeader10", ...], } }, data: { points: [ { "PointsHeader1": ..., "PointsHeader2": ..., ... }, { "PointsHeader1": ..., "PointsHeader2": ..., ... }, { "PointsHeader1": ..., "PointsHeader2": ..., ... }, ... ] } }
(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/globe", version: "1", data: { points: [ { lat: ..., lng: ..., metadata: [...] }, ... ] }, ... }
And the full list of all possible properties is as follows:
{ template: "@flourish/globe", version: "1", data: { points: [ { name: ..., lat: ..., lng: ..., radius: ..., color: ..., start_time: ..., end_time: ..., filter: ..., metadata: [...] }, ... ] }, ... }
Meanings of the template data keys:
- points.name: Use this binding to add a title to your points' popups. string
- points.lat: lat number
- points.lng: lng number
- points.radius: radius number
- points.color: color number, string
- points.start_time: start_time datetime
- points.end_time: end_time datetime
- points.filter: filter string, number, datetime
- points.metadata: Makes additional columns (text, emoji, image URLs, etc) available in custom popups 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/globe", version: "1", ... data: { points: [ [ "PointsColumn1Value1", "PointsColumn2Value1", [ "PointsColumn1Value2", "PointsColumn2Value2", [ "PointsColumn1Value3", "PointsColumn2Value3", ... ] }, metadata: { points: { 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/globe", version: "1", data: { points: [ { "PointsHeader1": ..., "PointsHeader2": ..., ... }, { "PointsHeader1": ..., "PointsHeader2": ..., ... }, { "PointsHeader1": ..., "PointsHeader2": ..., ... }, ... ] }, metadata: { points: { "PointsHeader1": { type: ..., type_id: ..., output_format_id: ... }, "PointsHeader2": { 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
.
Globe
globe.style string
Globe style. Allowed values:
globe.realistic_clouds_enabled boolean
Display clouds.
globe.solid_theme string
Theme. Allowed values:
globe.is_custom hidden
Customise appearance.
globe.solid_custom_ocean color
Ocean.
globe.solid_custom_land color
Land.
globe.solid_custom_border color
Borders.
globe.solid_ambient_color color
Ambient.
globe.solid_shadow_color color
Shadow.
globe.solid_halo_color color
Halo.
globe.solid_halo_blend string
Halo blend mode. Allowed values:
globe.solid_stroke_width number
Globe outline width.
globe.sun_direction_kind string
Sun direction. Allowed values:
globe.sun_direction_lat number
Latitude.
globe.sun_direction_lng number
Longitude.
background.type string
Allowed values:
- stars (Enabled)
- transparent (Disabled)
globe.stars_color_background color
Background.
globe.stars_color_stars color
Stars.
background.stars_size number
Star size.
Points
points.default_color color
Color.
points.point_opacity number
Opacity. Max: 100
points.point_max_size number
Max. size. Max: 100
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.
points.outline_mode string
Mode. Allowed values:
points.outline_opacity number
Opacity. Max: 100
points.outline_width number
Width. Max: 16
points.outline_color color
Color.
points.transition_style string
Style. Allowed values:
points.transition_duration number
Duration (s). Max: 10
points.formatting.prefix string
Prefix. Text to place in front of a number
points.formatting.suffix string
Suffix. Text to place after a number
points.formatting.n_dec number
Decimal places. Decimal places. You can also enter a negative integer to round to a whole number with that many zeros. For example, -2 will round to the nearest hundred. Min: -10 Max: 10
points.formatting.advanced boolean
Advanced.
points.formatting.negative_sign string
Styling of negative numbers. Allowed values:
points.formatting.strip_zeros boolean
Remove trailing zeros.
points.formatting.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”.
points.formatting.transform_labels boolean
Multiply/divide values.
points.formatting.transform string
Allowed values:
- multiply (Multiply by)
- divide (Divide by)
- exponentiate (×10 to the power of)
points.formatting.multiply_divide_constant number
points.formatting.exponentiate_constant number
Camera and controls
viewport.mode string
Starting location. Control the viewpoint of your globe when users access it for the first time. Allowed values:
viewport.preset_id string
Allowed values:
- timezone (Based on viewer's timezone)
- africa (Africa)
- antarctica (Antarctica)
- asia (Asia)
- oceania (Australia/Oceania)
- europe (Europe)
- north america (North America)
- south america (South America)
viewport.manual_lat number
Latitude.
viewport.manual_lng number
Longitude.
viewport.manual_zoom number
Zoom. Max: 2.5
interaction.is_interactive boolean
Allow user interaction. When enabled, allows control over user interaction, including panning,
zooming and rotating the globe.
interaction.allow_rotation boolean
Allow rotation. When enabled, allows the user to click and drag to rotate the globe.
interaction.allow_zoom boolean
Allow zoom. When enabled, allows the user to zoom in and out.
interaction.block_native_scroll boolean
Require user to hold down cmd/ctrl to zoom. When enabled, the user must hold down the cmd or ctrl key to be able zoom
in or out when scrolling. It's recommended this setting is enabled when
the visualisation is expected to take up a large part of the screen, as
without it they might not be able to scroll past the visualisation.
camera.transition_duration number
Duration between slides (seconds). The amount of time to spend animating between slides in the story editor. Max: 20
Timeline
timeline.enabled boolean
Allowed values:
- true (Enabled)
- false (Disabled)
timeline.style string
Style. Allowed values:
timeline.graph boolean
Show chart. Allowed values:
timeline.play_on_load boolean
Play on load.
timeline.loop boolean
Loop timeline. When turned on, the timeline will return to the beginning once complete. Otherwise, it will stop when it reaches the end.
timeline.duration number
Timeline duration. Total duration of the timeline during normal playback in seconds.
timeline.duration_tween number
Time jump duration. Duration of transitions between different points in time on the timeline.
This is the transition you see in the story player when switching between slides with a different time on the timeline (in seconds).
timeline.duration_wait_at_end number
Pause before loop.
timeline.axes_custom_enabled boolean
Axis settings.
timeline.color_axes color
Axes color.
timeline.axis_font_size number
Font size. Max: 3
timeline.date_format_display string
X axis date format. Predefined values:
timeline.axis_nice_x boolean
Clean X axis. Rounds out the X axis so that its start and end values are nice, round dates
timeline.axis_nice_y boolean
Clean Y axis. Rounds out the Y axis so that its start and end values are nice, round numbers
timeline.scrubber_snap boolean
Snap when scrubbing. When turned on, you can only jump to values that are supplied in the dataset and nothing in between
timeline.scrubber_snap_paused boolean
Snap when paused. Activate to snap the timeline to the closest interval when non animating. This is useful for ensuring the data visible in the visualization always reflects the data you have supplied.
timeline.layout_settings boolean
Layout settings.
timeline.margin.top number
Top.
timeline.margin.left number
Left.
timeline.margin.bottom number
Bottom.
timeline.margin.right number
Right.
timeline.playback_button.margin_right number
Space between button and timeline.
timeline.scrubber_height number
Scrubber height.
timeline.playback_button.margin_right_button number
Space between button and text.
timeline.graph_settings boolean
Chart settings.
timeline.color_background color
Background.
timeline.graph_height number
Height.
timeline.curve boolean
Curved lines.
timeline.playback_styling boolean
Play button settings.
timeline.playback_button.button_color color
Button color.
timeline.playback_button.button_size number
Button size. Max: 8
timeline.playback_button.icon_color color
Icon color.
timeline.playback_button.icon_size number
Icon size. Max: 8
timeline.playback_button.label_size number
Label size. Max: 8
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:
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
Popups
popup_points.mode string
Allowed values:
- none (None)
- popup (Popup)
- panel (Panel)
- both (Both)
popup_points.popup_is_custom boolean
Popup content. Allowed values:
popup_points.show_popup_styles boolean
Show popup styles.
popup_points.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_points.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_points.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_points.popup_width number
Max width. In rems, multiples of base font size. Leave blank to let the width adjust based on the contents.
popup_points.popup_font_size number
Text size.
popup_points.popup_text_color color
Text color.
popup_points.popup_align string
Align. Allowed values:
popup_points.popup_background color
Fill color.
popup_points.popup_background_opacity number
Fill opacity. Max: 1
popup_points.popup_padding number
Padding.
popup_points.popup_radius number
Radius. Corner radius of popup
popup_points.popup_header_type string
Header style. Allowed values:
popup_points.popup_header_background color
Background.
popup_points.popup_header_text_color color
Text.
popup_points.popup_list_type string
List type. Allowed values:
popup_points.popup_list_label_weight string
Label weight. Allowed values:
popup_points.popup_list_separator string
List separator. Predefined values:
popup_points.popup_shadow boolean
Shadow.
popup_points.popup_pointer boolean
Pointer.
popup_points.panel_position string
Allowed values:
- overlay (Overlay)
- left (Left)
- right (Right)
- top (Top)
- bottom (Bottom)
popup_points.panel_open_duration number
Open duration. Max: 2000
popup_points.panel_side_fixed boolean
Always show.
popup_points.panel_side_default_content text
Placeholder content.
popup_points.panel_is_custom boolean
Panel content. Allowed values:
popup_points.show_panel_styles boolean
Show panel styles.
popup_points.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_points.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_points.panel_width_overlay number
Width (%).
popup_points.panel_height_overlay number
Height (%).
popup_points.panel_width_side number
Width (%).
popup_points.panel_height_side number
Height (%).
popup_points.panel_max_width number
Max width (px).
popup_points.panel_max_height number
Max height (px).
popup_points.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_points.panel_text_color color
Text color.
popup_points.panel_font_size number
Text size.
popup_points.panel_align string
Alignment. Allowed values:
popup_points.panel_background color
Fill color.
popup_points.panel_background_opacity number
Fill opacity. Max: 1
popup_points.panel_padding number
Padding.
popup_points.panel_radius number
Radius. Corner radius of panel
popup_points.panel_list_type string
List type. Allowed values:
popup_points.panel_list_label_weight string
Label weight. Allowed values:
popup_points.panel_list_separator string
List separator. Predefined values:
popup_points.panel_shadow boolean
Shadow.
Legend
legend_categorical.show_legend boolean
Allowed values:
- true (Enabled)
- false (Disabled)
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
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.
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:
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: