Survey
Updated 5 days ago to v16.1.1 by Flourish team
How to use this template
This template is ideal for visualizing survey responses and other data where each row represents a discrete entity such as a person. It lets you animate dots into different views, including groups, bars, and – for geographic data – a map. It also allows you to compare different metrics in a grid view.
Data requirements
The survey template is ideal for datasets up to around 10,000 rows. Larger datasets will work, but perform more slowly.
You'll need a CSV or Excel file with a row for each person or entity that you want to visualize.
In the case of survey data, your CSV file should have:
- a row for each person who took the survey
- a column for each question in the survey or other piece of information about the respondent
Getting started
First, from your projects page, create a new Survey visualization. Open the Data view, go to the “Data” sheet and import your data to overwrite the current sheet. Then, on the right, update the column settings:
- Set “Categorical columns” to point to any columns with categorical answers, i.e. text like "male"/"female" or "0-99"/"100-999"/"1000-9990". Type in the column numbers - e.g.
A-C
. These columns will appear in in the “Group by”, “Shade by” and “Compare” dropdown in the visualization. - Set “Continuous columns” to point to any columns with continuous answers, i.e. raw numbers, such as income or weight. These columns will appear in the “Size by” dropdown in the visualization.
If you switch back to the Preview view, you should now see your data in the survey.
Change the text displayed
It's quite common that you want to change text shown in the visualization - for example, you might have y
and n
as answers in your raw data, but want this to be displayed as yes
or no
in your visualization.
To avoid editing the raw data (which may make it harder to update later), you can use the “Label overrides” sheet. Simply type the values you want to change (e.g. y
) in the first column and the values you want to show (e.g. yes
) in the second column. The visualization should automatically update to show the new text.
Change the ordering of groups
It's also quite common that you want to change the order of answers, which by default will display alphabetically. For example, you might prefer to show groups for Yes
, No
, and Answer not supplied
in that order.
To do this, go to the “Group order” data sheet, and fill in the heading of column A with the column name of the relevant question in the “Data” sheet. Underneath, type or paste in the answer values in the order that you'd like them displayed. Then, in the column settings panel, update “Order of answers” to point at column A.
You can repeat this for as many columns as necessary.
Bundle small groups
Sometimes you have a large number of categories that contain only a few dots each, which may clutter the graphic. If you enable the option to “Bundle small groups” then you can combine them into a single “Other” category.
Customise the popups
In the column selection panel, find “Metadata” and add any columns that you want to include in popups. Then, in the settings panel, ensure “Show popups” is checked, and edit “Popup contents” to include the columns, with column names in {{brackets}}
.
The “Popup contents” is HTML, so you can include formatting, e.g. <strong>Name:</strong> {{Name}}
, or even images if you include image URL in your data sheet.
If this isn’t working, check you're using the exact column names and that you haven't included spaces inside the brackets - so {{Name}}
not {{ Name }}
.
Let users filter the data
You can allow users to filter your survey results within the visualization - e.g. by year or another attribute.
To do this, in the column selection panel, set “Slider or menu” to the column you want to filter by.
Then, in the settings panel, choose “Control style” to specify the type of filter control you want - a button group, dropdown, or slider.
Grouped question
Survey data often includes grouped questions – i.e. those in the form "What food do you like (pick up to three)". In this model, the data sheet would typically include a column for each possible answer with a yes or no answer. The template allows you to group these questions together to enable you to compare the frequency of the positive answers.
When grouping by such a question, the number of dots may increase, because each survey respondent may appear multiple times – one for each positive answer. Because of this it's not possible to shade by a grouped question.
To create a grouped question, use the “Answer Groups” sheet. Put in the question you want to create in the first column, the column header for each sub-question in the next column, the display name for the group in the following column, and finally the way a positive answer is seen – e.g. “y” or “1”.
Display your data on a map
If you have country names in your data, you can display the data on a map without doing much extra work. Just ensure that the “Geographic columns” setting points at the column with country names in it, and that your country names match the “Countries” sheet.
If your data has other geographic locations, such as city names, you'll need to do a bit more work! First, ensure that the “Geographic columns” setting points at the column with locations in it. Then replace the “Countries” sheet with your geographic locations - you'll need latitude, longitude and name columns.
If you're adding a custom map, make sure to add it in an equirectangular projection and add the bounding box.
To change the default position displayed on the map, you'll need to create a Flourish story. Inside the story, click the map view, then zoom to the position you want to display: the slide will save the position. Publish the story to share it with your users.
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/survey
version: 16
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: { questions: [ [ "QuestionsColumn1Value1", "QuestionsColumn2Value1", [ "QuestionsColumn1Value2", "QuestionsColumn2Value2", [ "QuestionsColumn1Value3", "QuestionsColumn2Value3", ... ], order: [ [ "OrderColumn1Value1", "OrderColumn2Value1", [ "OrderColumn1Value2", "OrderColumn2Value2", [ "OrderColumn1Value3", "OrderColumn2Value3", ... ], labels: [ [ "LabelsColumn1Value1", "LabelsColumn2Value1", [ "LabelsColumn1Value2", "LabelsColumn2Value2", [ "LabelsColumn1Value3", "LabelsColumn2Value3", ... ], colors: [ [ "ColorsColumn1Value1", "ColorsColumn2Value1", [ "ColorsColumn1Value2", "ColorsColumn2Value2", [ "ColorsColumn1Value3", "ColorsColumn2Value3", ... ], places: [ [ "PlacesColumn1Value1", "PlacesColumn2Value1", [ "PlacesColumn1Value2", "PlacesColumn2Value2", [ "PlacesColumn1Value3", "PlacesColumn2Value3", ... ], answer_groups: [ [ "Answer_groupsColumn1Value1", "Answer_groupsColumn2Value1", [ "Answer_groupsColumn1Value2", "Answer_groupsColumn2Value2", [ "Answer_groupsColumn1Value3", "Answer_groupsColumn2Value3", ... ] } }
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/survey", version: "16", bindings: { questions: { }, order: { }, labels: { label: 0, // index of a column in your data replacement: 1, // index of a column in your data }, colors: { question: 0, // index of a column in your data answer: 1, // index of a column in your data color: 2, // index of a column in your data }, places: { latitude: 0, // index of a column in your data longitude: 1, // index of a column in your data }, answer_groups: { group: 0, // index of a column in your data question: 1, // index of a column in your data display_as: 2, // index of a column in your data } }, data: { questions: [ [ "QuestionsColumn1Value1", "QuestionsColumn2Value1", [ "QuestionsColumn1Value2", "QuestionsColumn2Value2", [ "QuestionsColumn1Value3", "QuestionsColumn2Value3", ... ], order: [ [ "OrderColumn1Value1", "OrderColumn2Value1", [ "OrderColumn1Value2", "OrderColumn2Value2", [ "OrderColumn1Value3", "OrderColumn2Value3", ... ], labels: [ [ "LabelsColumn1Value1", "LabelsColumn2Value1", [ "LabelsColumn1Value2", "LabelsColumn2Value2", [ "LabelsColumn1Value3", "LabelsColumn2Value3", ... ], colors: [ [ "ColorsColumn1Value1", "ColorsColumn2Value1", [ "ColorsColumn1Value2", "ColorsColumn2Value2", [ "ColorsColumn1Value3", "ColorsColumn2Value3", ... ], places: [ [ "PlacesColumn1Value1", "PlacesColumn2Value1", [ "PlacesColumn1Value2", "PlacesColumn2Value2", [ "PlacesColumn1Value3", "PlacesColumn2Value3", ... ], answer_groups: [ [ "Answer_groupsColumn1Value1", "Answer_groupsColumn2Value1", [ "Answer_groupsColumn1Value2", "Answer_groupsColumn2Value2", [ "Answer_groupsColumn1Value3", "Answer_groupsColumn2Value3", ... ] } }
All possible bindings that you can supply are shown in this example:
{ template: "@flourish/survey", version: "16", bindings: { questions: { categorical: [0, 1, ...], // index(es) of column(s) in your data continuous: [2, 3, ...], // index(es) of column(s) in your data geo: [4, 5, ...], // index(es) of column(s) in your data label: 6, // index of a column in your data column_filter: 7, // index of a column in your data id: 8, // index of a column in your data metadata: [9, 10, ...], // index(es) of column(s) in your data }, order: { categories: [0, 1, ...], // index(es) of column(s) in your data }, labels: { label: 0, // index of a column in your data replacement: 1, // index of a column in your data }, colors: { question: 0, // index of a column in your data answer: 1, // index of a column in your data color: 2, // index of a column in your data }, places: { latitude: 0, // index of a column in your data longitude: 1, // index of a column in your data names: [2, 3, ...], // index(es) of column(s) in your data }, answer_groups: { group: 0, // index of a column in your data question: 1, // index of a column in your data display_as: 2, // index of a column in your data affirmative_answers: [3, 4, ...], // index(es) of column(s) in your data } }, data: { questions: [ [ "QuestionsColumn1Value1", "QuestionsColumn2Value1", [ "QuestionsColumn1Value2", "QuestionsColumn2Value2", [ "QuestionsColumn1Value3", "QuestionsColumn2Value3", ... ], order: [ [ "OrderColumn1Value1", "OrderColumn2Value1", [ "OrderColumn1Value2", "OrderColumn2Value2", [ "OrderColumn1Value3", "OrderColumn2Value3", ... ], labels: [ [ "LabelsColumn1Value1", "LabelsColumn2Value1", [ "LabelsColumn1Value2", "LabelsColumn2Value2", [ "LabelsColumn1Value3", "LabelsColumn2Value3", ... ], colors: [ [ "ColorsColumn1Value1", "ColorsColumn2Value1", [ "ColorsColumn1Value2", "ColorsColumn2Value2", [ "ColorsColumn1Value3", "ColorsColumn2Value3", ... ], places: [ [ "PlacesColumn1Value1", "PlacesColumn2Value1", [ "PlacesColumn1Value2", "PlacesColumn2Value2", [ "PlacesColumn1Value3", "PlacesColumn2Value3", ... ], answer_groups: [ [ "Answer_groupsColumn1Value1", "Answer_groupsColumn2Value1", [ "Answer_groupsColumn1Value2", "Answer_groupsColumn2Value2", [ "Answer_groupsColumn1Value3", "Answer_groupsColumn2Value3", ... ] } }
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:
{ questions: [ { "QuestionsHeader1": ..., "QuestionsHeader2": ..., ... }, { "QuestionsHeader1": ..., "QuestionsHeader2": ..., ... }, { "QuestionsHeader1": ..., "QuestionsHeader2": ..., ... }, ... ], order: [ { "OrderHeader1": ..., "OrderHeader2": ..., ... }, { "OrderHeader1": ..., "OrderHeader2": ..., ... }, { "OrderHeader1": ..., "OrderHeader2": ..., ... }, ... ], labels: [ { "LabelsHeader1": ..., "LabelsHeader2": ..., ... }, { "LabelsHeader1": ..., "LabelsHeader2": ..., ... }, { "LabelsHeader1": ..., "LabelsHeader2": ..., ... }, ... ], colors: [ { "ColorsHeader1": ..., "ColorsHeader2": ..., ... }, { "ColorsHeader1": ..., "ColorsHeader2": ..., ... }, { "ColorsHeader1": ..., "ColorsHeader2": ..., ... }, ... ], places: [ { "PlacesHeader1": ..., "PlacesHeader2": ..., ... }, { "PlacesHeader1": ..., "PlacesHeader2": ..., ... }, { "PlacesHeader1": ..., "PlacesHeader2": ..., ... }, ... ], answer_groups: [ { "Answer_groupsHeader1": ..., "Answer_groupsHeader2": ..., ... }, { "Answer_groupsHeader1": ..., "Answer_groupsHeader2": ..., ... }, { "Answer_groupsHeader1": ..., "Answer_groupsHeader2": ..., ... }, ... ] }
... 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/survey", version: "16", bindings: { questions: { }, order: { }, labels: { label: "LabelsHeader1", replacement: "LabelsHeader2", }, colors: { question: "ColorsHeader1", answer: "ColorsHeader2", color: "ColorsHeader3", }, places: { latitude: "PlacesHeader1", longitude: "PlacesHeader2", }, answer_groups: { group: "Answer_groupsHeader1", question: "Answer_groupsHeader2", display_as: "Answer_groupsHeader3", } }, data: { questions: [ { "QuestionsHeader1": ..., "QuestionsHeader2": ..., ... }, { "QuestionsHeader1": ..., "QuestionsHeader2": ..., ... }, { "QuestionsHeader1": ..., "QuestionsHeader2": ..., ... }, ... ], order: [ { "OrderHeader1": ..., "OrderHeader2": ..., ... }, { "OrderHeader1": ..., "OrderHeader2": ..., ... }, { "OrderHeader1": ..., "OrderHeader2": ..., ... }, ... ], labels: [ { "LabelsHeader1": ..., "LabelsHeader2": ..., ... }, { "LabelsHeader1": ..., "LabelsHeader2": ..., ... }, { "LabelsHeader1": ..., "LabelsHeader2": ..., ... }, ... ], colors: [ { "ColorsHeader1": ..., "ColorsHeader2": ..., ... }, { "ColorsHeader1": ..., "ColorsHeader2": ..., ... }, { "ColorsHeader1": ..., "ColorsHeader2": ..., ... }, ... ], places: [ { "PlacesHeader1": ..., "PlacesHeader2": ..., ... }, { "PlacesHeader1": ..., "PlacesHeader2": ..., ... }, { "PlacesHeader1": ..., "PlacesHeader2": ..., ... }, ... ], answer_groups: [ { "Answer_groupsHeader1": ..., "Answer_groupsHeader2": ..., ... }, { "Answer_groupsHeader1": ..., "Answer_groupsHeader2": ..., ... }, { "Answer_groupsHeader1": ..., "Answer_groupsHeader2": ..., ... }, ... ] } }
All possible bindings that you can supply are shown in this example:
{ template: "@flourish/survey", version: "16", bindings: { questions: { categorical: ["QuestionsHeader1", "QuestionsHeader2", ...], continuous: ["QuestionsHeader3", "QuestionsHeader4", ...], geo: ["QuestionsHeader5", "QuestionsHeader6", ...], label: "QuestionsHeader7", column_filter: "QuestionsHeader8", id: "QuestionsHeader9", metadata: ["QuestionsHeader10", "QuestionsHeader11", ...], }, order: { categories: ["OrderHeader1", "OrderHeader2", ...], }, labels: { label: "LabelsHeader1", replacement: "LabelsHeader2", }, colors: { question: "ColorsHeader1", answer: "ColorsHeader2", color: "ColorsHeader3", }, places: { latitude: "PlacesHeader1", longitude: "PlacesHeader2", names: ["PlacesHeader3", "PlacesHeader4", ...], }, answer_groups: { group: "Answer_groupsHeader1", question: "Answer_groupsHeader2", display_as: "Answer_groupsHeader3", affirmative_answers: ["Answer_groupsHeader4", "Answer_groupsHeader5", ...], } }, data: { questions: [ { "QuestionsHeader1": ..., "QuestionsHeader2": ..., ... }, { "QuestionsHeader1": ..., "QuestionsHeader2": ..., ... }, { "QuestionsHeader1": ..., "QuestionsHeader2": ..., ... }, ... ], order: [ { "OrderHeader1": ..., "OrderHeader2": ..., ... }, { "OrderHeader1": ..., "OrderHeader2": ..., ... }, { "OrderHeader1": ..., "OrderHeader2": ..., ... }, ... ], labels: [ { "LabelsHeader1": ..., "LabelsHeader2": ..., ... }, { "LabelsHeader1": ..., "LabelsHeader2": ..., ... }, { "LabelsHeader1": ..., "LabelsHeader2": ..., ... }, ... ], colors: [ { "ColorsHeader1": ..., "ColorsHeader2": ..., ... }, { "ColorsHeader1": ..., "ColorsHeader2": ..., ... }, { "ColorsHeader1": ..., "ColorsHeader2": ..., ... }, ... ], places: [ { "PlacesHeader1": ..., "PlacesHeader2": ..., ... }, { "PlacesHeader1": ..., "PlacesHeader2": ..., ... }, { "PlacesHeader1": ..., "PlacesHeader2": ..., ... }, ... ], answer_groups: [ { "Answer_groupsHeader1": ..., "Answer_groupsHeader2": ..., ... }, { "Answer_groupsHeader1": ..., "Answer_groupsHeader2": ..., ... }, { "Answer_groupsHeader1": ..., "Answer_groupsHeader2": ..., ... }, ... ] } }
(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/survey", version: "16", data: { questions: [ { categorical: [...], continuous: [...], geo: [...], metadata: [...] }, ... ], order: [ { categories: [...] }, ... ], labels: [ { label: ..., replacement: ... }, ... ], colors: [ { question: ..., answer: ..., color: ... }, ... ], places: [ { latitude: ..., longitude: ..., names: [...] }, ... ], answer_groups: [ { group: ..., question: ..., display_as: ..., affirmative_answers: [...] }, ... ] }, ... }
And the full list of all possible properties is as follows:
{ template: "@flourish/survey", version: "16", data: { questions: [ { categorical: [...], continuous: [...], geo: [...], label: ..., column_filter: ..., id: ..., metadata: [...] }, ... ], order: [ { categories: [...] }, ... ], labels: [ { label: ..., replacement: ... }, ... ], colors: [ { question: ..., answer: ..., color: ... }, ... ], places: [ { latitude: ..., longitude: ..., names: [...] }, ... ], answer_groups: [ { group: ..., question: ..., display_as: ..., affirmative_answers: [...] }, ... ] }, ... }
Meanings of the template data keys:
- questions.categorical: Each of these columns appears in the <b>Group by</b>, <b>Shade by</b> and <b>Compare</b> dropdowns.
- questions.continuous: Must contain numbers. Each of these columns appears in the <b>Size by</b> dropdown.
- questions.geo: Must contain place names matching those specified in the <b>Places</b> sheet. Set to blank to disable the map mode.
- questions.label: A column containing text (e.g. names or emoji) to write on the dots. Not recommended for datasets with more than a few hundred dots.
- questions.column_filter: Add a time slider or menu to <a href="https://help.flourish.studio/article/573-how-row-and-column-filters-work">filter</a> the data based on the contents of a single column
- questions.id: Specify to allow animations between multiple occurrences of the same person or thing – e.g. when using a time slider
- questions.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">popups and panels</a>.
- order.categories: Use one column for each question or metric. Put the column header from the main data sheet at the top (e.g. "Do you agree?"), followed by the answers in the order you want (e.g. "disagree", "neutral", "agree")
- labels.label: A column containing phrases from the main data sheet
- labels.replacement: A column containing the phrase to display
- colors.question: The column header (e.g. a survey question) exactly as it appears in the main data sheet
- colors.answer: Use one column for each question or metric. Put the column header from the main datasheet at the top (e.g. "Do you agree?"), followed by the answers in <a href="https://help.flourish.studio/article/127-how-to-change-the-ordering-of-your-groups-in-the-survey-template">the order</a> you want (e.g. "disagree", "neutral", "agree")
- colors.color: A color name (e.g. orange, red) or code (e.g. #ff3300, #ff0000)
- places.latitude: A column of latitude values
- places.longitude: A column of longitude values
- places.names: One or more columns of place names matching those in the main data sheet
- answer_groups.group: This column will contain the name of the <a href="https://help.flourish.studio/article/135-how-to-create-a-grouped-question-in-the-survey-template">grouped question</a>
- answer_groups.question: A question that matches exactly one of the questions in the datasheet
- answer_groups.display_as: This will be the new text for the question
- answer_groups.affirmative_answers: The respondent is included in the group if their answer to the question is one of the answers listed in these columns
Template settings
Options for opts.state
.
Dots
dot_fill color
Default color. If left blank, the first color in the color palette will be used
dot_opacity number
Opacity. Max: 1
dot_opacity_unhighlighted number
Opacity (unhighlighted). The opacity of the unhighlighted dots when one of the dots is highlighted Max: 1
color.categorical_palette colors
Color when shading. The colors to use when shading by the answer to a questions
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 name of the category that 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)
Note that overrides from the "Color overrides" sheet take priority over the overrides in this setting.
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.
dot_shape string
Shape. Allowed values:
dot_sides number
Sides. Min: 3 Max: 16
outline_width number
Stroke width. In pixels. The width of the outline stroke. Max: 5
outline_color color
Stroke color. Outline color for your dots/squares/polygons. If not set, the layout background color will be used.
Dot labels
dot_label string
Default label or emoji. A label or emoji to show on each dot. Overriden by any label specified using the Label column setting.
dot_label_color color
Color.
dot_label_bold boolean
Bold.
dot_label_min number
Min size to display. The minimum text size in pixels for dot labels. Below this level they will not render.
dot_label_auto_size boolean
Sizing mode. Allowed values:
dot_label_fixed number
Size in %. Specifies font size across the graphic as a percentage of dot height
dot_label_scale number
Scale. Scales the labels up or down from their default size
dot_label_size_value boolean
Show numerical value when sizing dots.
Groups
all_group_label string
Name for "all" group.
include_grouped_questions_on_shade_menu boolean
Include grouped questions on shading menu.
include_grouped_questions_on_compare_menu boolean
Include grouped questions on compare menu.
order_groups_by_size boolean
Order groups by size.
order_groups_by_size_mode string
Allowed values:
- ascending (Smallest to largest)
- descending (Largest to smallest)
group_colors boolean
Arrange groups by color. If selected, dots of the same color are grouped together; if not the dots are placed in spreadsheet order
exclusions string
Exclude groups with the following names. Case-sensitive comma-separated list
exclude_blanks boolean
Exclude groups with blank names.
bundle_small_groups boolean
Bundle small groups.
small_groups_threshold number
Min size.
small_groups_other_label string
"Other" group label.
Group labels
label_mode string
Label position. Allowed values:
label_tight_fit boolean
Position close to group.
label_color color
Text color.
label_min_font_size number
Min font size. In pixels; the actual font size in any view is set automatically between the min and max
label_max_font_size number
Max font size. In pixels; the actual font size in any view is set automatically between the min and max
label_group_padding_lines number
Space for labels. The amount of space to leave above the groups, specified in lines of text
label_shadow_size number
Size. As percent of font size Max: 100
label_shadow_color color
Color.
label_group_count boolean
Show number of dots in group. Adds the number in brackets after the main label; ignored in chart, map and compare modes
label_group_percent boolean
Show group size as % of visible dots. Adds group size as a percent of visible dots, in brackets after the main label.
This setting is ignored in chart, map and compare modes and when showing a grouped question.
label_group_percent_decimals number
Decimal places on percentage labels.
always_show_x_label boolean
Show X label when not comparing. Show the groups label at the bottom of chart when not comparing two metrics
show_xy_axis_labels_when_comparing boolean
Show X/Y labels when comparing. Show groups labels on both axes when comparing two metrics
compare_y_axis_width number
Y axis width.
compare_x_axis_height number
X axis height.
Height mode
chart_height_mode string
Height mode. How the graphic height will be set when embedded with the responsive script embed without a specified height Allowed values:
chart_aspect_ratio_wide number
Desktop. The chart aspect ratio on screens 640 pixels wide and higher (1 for square - a smaller value means a bigger height) Min: 0.1 Max: 10
chart_aspect_ratio_narrow number
Mobile. The chart aspect ratio on screens narrower than 640 pixels (1 for square - a smaller value means a bigger height) Min: 0.1 Max: 10
Map
map_opacity_map_mode number
Map opacity (in map mode). Max: 1
map_opacity_non_map_mode number
Map opacity (in other modes). Max: 1
map_max_group_size number
Max group size in map view. In relative units Min: 0.1
map_dimensions string
Map dimensions. Allowed values:
map_aspect_ratio number
Map aspect ratio. Aspect ratio of the map. 1 will make the map square. Min: 0.1
map_region string
Region. Allowed values:
map_region_url url
Url to equirectangular projection of map.
map_region_bounds.x1 number
Minimum longitude. Min: -180 Max: 180
map_region_bounds.x2 number
Maximum longitude. Min: -180 Max: 180
map_region_bounds.y2 number
Minimum latitude. Min: -90 Max: 90
map_region_bounds.y1 number
Maximum latitude. Min: -90 Max: 90
Popups & panels
popup.mode string
Allowed values:
- none (None)
- popup (Popup)
- panel (Panel)
- both (Both)
popup.popup_is_custom boolean
Popup content. Allowed values:
popup.show_popup_styles boolean
Show popup styles.
popup.popup_custom_header html
Popup custom header. Use {{column_name}} to add a value from your data. Ensure the column is selected, or add it to Info for popups for popup use.
Advanced users can add HTML styling or add category colors to popup headers.
To hide parts of the popup when a column is empty using {{#if column_name}}Content for non-empty column_name{{/if}}.
For example: {{#if Capital name}}Capital:{{/if}} {{Capital name}}.
Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.
popup.popup_custom_main html
Popup custom main content. Use {{column_name}} to add a value from your data. Ensure the column is selected, or add it to Info for popups for popup use.
Advanced users can add HTML for designs, styles, and images.
To hide parts of the popup when a column is empty use the syntax {{#if column_name}}Content for non-empty column_name{{/if}}.
For example: {{#if Capital name}}Capital:{{/if}} {{Capital name}}.
Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.
popup.popup_custom_accessible text
Popup custom accessible content. A text alternative to visual custom popup content that will be read out by screenreaders. This content is added as an aria-label
attribute to data point elements. You can still use {{column_name}} to add values from your data, but do not use HTML. For example: {Name}}, Population: {{Population}}, GDP: {{GDP}}
If left empty, accessible content will fallback to the default popup content.
popup.popup_width number
Max width. In rems, multiples of base font size. Leave blank to let the width adjust based on the contents.
popup.popup_font_size number
Text size.
popup.popup_text_color color
Text color.
popup.popup_align string
Align. Allowed values:
popup.popup_background color
Fill color.
popup.popup_background_opacity number
Fill opacity. Max: 1
popup.popup_padding number
Padding.
popup.popup_radius number
Radius. Corner radius of popup
popup.popup_header_type string
Header style. Allowed values:
popup.popup_header_background color
Background.
popup.popup_header_text_color color
Text.
popup.popup_list_type string
List type. Allowed values:
popup.popup_list_label_weight string
Label weight. Allowed values:
popup.popup_list_separator string
List separator. Predefined values:
popup.popup_shadow boolean
Shadow.
popup.popup_pointer boolean
Pointer.
popup.panel_position string
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:
popup.show_panel_styles boolean
Show panel styles.
popup.panel_custom_header html
Panel custom header. Use {{column_name}} to add a value from your data. Ensure the column is selected, or add it to Info for popups for panel use.
Advanced users can add HTML for styling or add category colors to panel headers.
To hide parts of the panel when a column is empty using {{#if column_name}}Content for non-empty column_name{{/if}}.
For example: {{#if Capital name}}Capital:{{/if}} {{Capital name}}.
Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.
popup.panel_custom_main html
Panel custom main content. Use {{column_name}} to add a value from your data. Ensure the column is selected, or add it to Info for popups for panel use.
Advanced users can add HTML for designs, styles, images, videos and embedded Flourish charts,
To hide parts of the panel when a column is empty using {{#if column_name}}Content for non-empty column_name{{/if}}.
For example: {{#if Capital name}}Capital:{{/if}} {{Capital name}}.
Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.
popup.panel_width_overlay number
Width (%).
popup.panel_height_overlay number
Height (%).
popup.panel_width_side number
Width (%).
popup.panel_height_side number
Height (%).
popup.panel_max_width number
Max width (px).
popup.panel_max_height number
Max height (px).
popup.panel_vertical_position string
Vertical position. Choosing Click position is especially useful when your visualization is really tall, this will make sure the panel content is always on top of the element you've clicked on Allowed values:
popup.panel_text_color color
Text color.
popup.panel_font_size number
Text size.
popup.panel_align string
Alignment. Allowed values:
popup.panel_background color
Fill color.
popup.panel_background_opacity number
Fill opacity. Max: 1
popup.panel_padding number
Padding.
popup.panel_radius number
Radius. Corner radius of panel
popup.panel_list_type string
List type. Allowed values:
popup.panel_list_label_weight string
Label weight. Allowed values:
popup.panel_list_separator string
List separator. Predefined values:
popup.panel_shadow boolean
Shadow.
Controls
panel_background_color color
Background.
panel_background_opacity number
Opacity. Max: 1
panel_text_color color
Text color.
panel_text_size number
Text size.
panel_icon_color string
Icon color. Allowed values:
panel_width number
Panel width. Width of the controls panels on wide screens, ignored on mobile
panel_cog_color color
Cog icon color.
panel_overlay boolean
Overlay panel over graphic.
panel_hide_cog boolean
Disable controls toggle in published graphic. When checked, the controls icon for showing/<a href="https://help.flourish.studio/article/365-how-to-hide-controls-in-a-published-survey-visualization>hiding the controls panel is visible only in the visualization and story editors – not in the published visualization or story.
When making a story, you can still lock the panel to be visible or hidden by clicking the cog icon in the story editor.
select_group_show boolean
Group menu. Populated by all category columns
select_color_show boolean
Color menu. Populated by all category columns
select_size_show boolean
Size menu. Populated by all continuous number columns
select_compare_show boolean
Compare menu. Populated by all category columns; appears only when Group by is selected
histogram_show boolean
Bar mode.
select_group_text string
Group by.
select_color_text string
Shade by.
select_size_text string
Size by.
select_compare_text string
Compare.
select_filter_text string
Filter.
select_map_text string
Group location.
controls_filter.control_type string
Control type. Choose between a dropdown, buttons or a time slider. Allowed values:
controls_filter.control_styles boolean
Adv..
controls_filter.control_title string
Control title.
controls_filter.button_group boolean
Grouped. Allowed values:
controls_filter.button_group_width_mode string
Button group width. Allowed values:
controls_filter.button_group_width_fixed number
Width. Max: 100
controls_filter.dropdown_width_mode string
Dropdown width. Allowed values:
controls_filter.dropdown_width_fixed number
Width. Max: 100
controls_filter.slider_width number
Slider width. Width of the slider track in rems Max: 100
controls_filter.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
controls_filter.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
controls_filter.slider_loop boolean
Loop.
controls_filter.slider_restart_pause number
Pause before loop. Measured in seconds and in addition to the regular step time displayed above Max: 100
controls_filter.sort boolean
Sorting. Allowed values:
column_filter_show_all boolean
Include "All" in slider/menu.
column_filter_show_all_label string
Label for All.
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
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.
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
Legend
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_hide_space boolean
Remove space when empty. Turn off to avoid the legend taking up space when empty.
Leave on to avoid the graphic jumping up and down a little when the legend is revealed or hidden.
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
Zoom
zoom_on_double_click boolean
Zoom on double click.
zoom_on_mousewheel boolean
Zoom on pinch/mousewheel.
Animations
transition_duration number
Duration. Time in milliseconds of each dot's animation
transition_stagger number
Stagger. The spread of time over which the dots start animating
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: