This section documents API usage specific to this template, so for an introduction we suggest you refer to the generic API documentation instead.

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: "10",
    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: "10",
    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: "10",
    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: "10",
    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: "10",
    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: "10",
    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 “Group by”, “Shade by” and “Compare” dropdowns.
• questions.continuous: Must contain numbers. Each of these columns appears in the “Size by” dropdown.
• questions.geo: Must contain place names matching those specified in the “Places” 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 filter 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: Information to make available in the popups
• 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: The value (e.g. a survey answer) exactly as it appears in the Data sheet
• colors.color: A color name (e.g. orange, red) or code (e.g. #ff3300, #ff0000)
• places.latitude: A column of latitute 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 grouped question.
• answer_groups.question: A question that matches exactly one of the questions in the "Data" sheet
• 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. The color of the dots if nothing is selected on the “Shade by” menu

dot_opacity number

Opacity.

dot_opacity_unhighlighted number

Opacity (unhighlighted). The opacity of the unhighlighted dots when one of the dots is highlighted

color.scale_type string

Scale type.

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. Type the name of the entity whose color you want to set, a colon and then a color (using a name, hex-code or rgb declaration). 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.

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.

color.bin_mode string

Binning mode.

color.bin_count number

Number of bins.

color.bin_thresholds string

Custom thresholds. Write your custom thresholds, separated by a ";" For example 5;10;15

color.sequential_palette string

Palette.

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.

color.sequential_custom_domain boolean

Domain.

color.sequential_domain_min number

Min.

color.sequential_domain_max number

Max.

color.diverging_palette string

Palette.

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.

color.diverging_custom_domain boolean

Domain.

color.diverging_domain_min number

Min.

color.diverging_domain_mid number

Mid.

color.diverging_domain_max number

Max.

dot_shape string

Shape.

dot_sides number

Sides.

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.

dot_label_fixed number

Size in %. Specifies font size across the graphic as % 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.

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 postion.

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

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 to the labels group size as a in brackets after the main label; 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 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

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)

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)

Map

map_opacity_map_mode number

Map opacity (in map mode).

map_opacity_non_map_mode number

Map opacity (in other modes).

map_max_group_size number

Max group size in map view. In relative units

map_dimensions string

Map dimensions.

map_aspect_ratio number

Map aspect ratio. Aspect ratio of the map. 1 will make the map square.

map_region string

Region.

map_region_url url

Url to equirectangular projection of map.

map_region_bounds.x1 number

Minimum longitude.

map_region_bounds.x2 number

Maximum longitude.

map_region_bounds.y2 number

Minimum latitude.

map_region_bounds.y1 number

Maximum latitude.

Popups & panels

popup.mode string

popup.popup_is_custom boolean

Popup content.

popup.show_popup_styles boolean

Show popup styles.

popup.popup_custom_header string

Popup custom header. The text to appear in the popup. You can use {{column_name}} to add a value from your data. It must be in a selected column, but you can add columns to “Metadata” if you just want to include them for use in the popup. Advanced users can include HTML to apply layouts, formatting, images, etc. You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}}

popup.popup_custom_main text

Popup custom main content. The text to appear in the popup. You can use {{column_name}} to add a value from your data. It must be in a selected column, but you can add columns to “Metadata” if you just want to include them for use in the popup. Advanced users can include HTML to apply layouts, formatting, images, etc. You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}}

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.

popup.popup_background color

Fill color.

popup.popup_background_opacity number

Fill opacity.

popup.popup_padding number

Padding.

popup.popup_radius number

Radius. Corner radius of popup

popup.popup_header_type string

Header style.

popup.popup_header_background color

Background.

popup.popup_header_text_color color

Text.

popup.popup_list_type string

List type.

popup.popup_list_label_weight string

Label weight.

popup.popup_list_separator string

List separator.

popup.popup_shadow boolean

Shadow.

popup.popup_pointer boolean

Pointer.

popup.panel_position string

popup.panel_open_duration number

Open duration.

popup.panel_side_fixed boolean

Always show.

popup.panel_side_default_content text

Placeholder content.

popup.panel_is_custom boolean

Panel content.

popup.show_panel_styles boolean

Show panel styles.

popup.panel_custom_header string

Panel custom header. The text to appear in the panel. You can use {{column_name}} to add a value from your data. It must be in a selected column, but you can add columns to “Metadata” if you just want to include them for use in the popup. Advanced users can include HTML to apply layouts, formatting, images, etc. You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}}

popup.panel_custom_main text

Panel custom main content. The text to appear in the panel. You can use {{column_name}} to add a value from your data. It must be in a selected column, but you can add columns to “Metadata” if you just want to include them for use in the popup. Advanced users can include HTML to apply layouts, formatting, images, etc. You can also hide content based on a column name being empty using {{# if column_name}}Text to display when column_name is not empty{{/if}}. For example: {{Country}} {{#if Capital}}(Capital: {{Capital}}){{/if}}

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 visualisation is really tall, this will make sure the panel content is always on top of the element you've clicked on

popup.panel_text_color color

Text color.

popup.panel_font_size number

Text size.

popup.panel_align string

Alignment.

popup.panel_background color

Fill color.

popup.panel_background_opacity number

Fill opacity.

popup.panel_padding number

Padding.

popup.panel_radius number

Radius. Corner radius of panel

popup.panel_list_type string

List type.

popup.panel_list_label_weight string

Label weight.

popup.panel_list_separator string

List separator.

popup.panel_shadow boolean

Shadow.

Controls

panel_background_color color

Background.

panel_background_opacity number

Opacity.

panel_text_color color

Text color.

panel_text_size number

Text size.

panel_icon_color string

Icon color.

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 cog icon for showing/hiding the controls panel is visible only in the visualisation and story editors – not in the published visualisation 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.

controls_filter.control_styles boolean

Adv..

controls_filter.button_group boolean

Grouped.

controls_filter.button_group_width_mode string

Button group width.

controls_filter.button_group_width_fixed number

Width.

controls_filter.dropdown_width_mode string

Dropdown width.

controls_filter.dropdown_width_fixed number

Width.

controls_filter.slider_background_color color

Background.

controls_filter.slider_font_color color

Text.

controls_filter.slider_handle_color color

Handle.

controls_filter.slider_width number

Width.

controls_filter.slider_margin number

Label width.

controls_filter.slider_handle_height number

Height.

controls_filter.slider_track_height number

Track height.

controls_filter.slider_play_button boolean

Play button.

controls_filter.slider_loop boolean

Loop.

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.

controls_filter.slider_restart_pause number

Pause before loop. Measured in seconds and in addition to the regular step time displayed above.

controls_filter.sort string

Sorting.

controls_filter.sort_temporal_format string

Date/time format in data. The date/time format in your data sheet. Used only to sort the data, if required. If your format isn’t in the list, you can enter a custom format using d3-time-format syntax. See npmjs.com/package/d3-time-format for details.

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.

controls_style.font_weight string

Text weight.

controls_style.padding number

Height. Space below and above controls text

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.

button_style.border_color color

Color.

button_style.border_transparency number

Transparency.

button_style.border_radius number

Radius.

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

dropdown_style.border_width number

Border width.

dropdown_style.border_color color

Color.

dropdown_style.border_transparency number

Transparency.

dropdown_style.border_radius number

Radius.

Legend

legend.show_legend boolean

legend.text_color color

Color.

legend.text_size number

Size.

legend.text_weight string

Weight.

legend.title_mode string

Title mode.

legend.title string

Title.

legend.title_weight string

Weight.

legend.swatch_width number

Width.

legend.swatch_height number

Height.

legend.swatch_radius number

Roundness. The radius of the corners of the swatch (in pixels)

legend.order_override text

Custom order override. Manually specify the order of legend entries (one entry per line)

legend.orientation string

Orientation.

legend_position string

Position.

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.

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, but you can optionally change the font for the title, subtitle, footer, etc in the Header and Footer settings panels.

layout.font_color color

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

layout.background_color_enabled boolean

Color.

layout.background_image_enabled boolean

Image.

layout.background_color color

Background color.

layout.background_image_src url

Image URL.

layout.background_image_size string

Size.

layout.background_image_position string

Position.

layout.max_width_target string

Maximum width. Apply a maximum width to just the main graphic or everything (main graphic plus header, footer, etc)

layout.max_width number

Maximum width. Leave blank to stretch to container width

layout.max_width_align string

Align.

layout.layout_order string

Layout order.

layout.space_between_sections string

Space between sections.

layout.space_between_sections_custom number

Custom.

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.

layout.border.top.color color

Color.

layout.border.right.width number

Right.

layout.border.right.style string

Style.

layout.border.right.color color

Color.

layout.border.bottom.width number

Bottom.

layout.border.bottom.style string

Style.

layout.border.bottom.color color

Color.

layout.border.left.width number

Left.

layout.border.left.style string

Style.

layout.border.left.color color

Color.

Header

layout.header_align string

Alignment.

layout.title string

layout.title_styling boolean

Change title styles.

layout.title_font font

Title Font.

layout.title_size string

Size.

layout.title_size_custom number

Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3

layout.title_weight string

Weight.

layout.title_color color

Color.

layout.title_line_height number

Line height.

layout.title_space_above string

Space above.

layout.title_space_above_custom number

Custom.

layout.subtitle string

layout.subtitle_styling boolean

Change subtitle styles.

layout.subtitle_font font

Subtitle Font.

layout.subtitle_size string

Size.

layout.subtitle_size_custom number

Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3

layout.subtitle_weight string

Weight.

layout.subtitle_color color

Color.

layout.subtitle_line_height number

Line height.

layout.subtitle_space_above string

Space above.

layout.subtitle_space_above_custom number

Custom.

layout.header_text string

layout.header_text_styling boolean

Styling.

layout.header_text_size string

Size.

layout.header_text_size_custom number

Custom. Specify a custom responsive font size. Best results will be with values between 1.2 and 3

layout.header_text_weight string

Weight.

layout.header_text_color color

Color.

layout.header_text_line_height number

Line height.

layout.header_text_space_above string

Space above.

layout.header_text_space_above_custom number

Custom.

layout.header_border string

layout.header_border_width number

Width.

layout.header_border_color color

Color.

layout.header_border_style string

Style.

layout.header_border_space number

Space. Space between border and header text

layout.header_logo_enabled boolean

layout.header_logo_src url

URL.

layout.header_logo_height number

Height.

layout.header_logo_align string

Align. Align logo inside header or outer visualisation container

layout.header_logo_position_inside string

Position.

layout.header_logo_position_outside string

Position.

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.

layout.footer_text_size number

Size.

layout.footer_text_color color

Color.

layout.footer_styling boolean

Advanced footer styles.

layout.footer_font font

Font.

layout.source_name string

Source name.

layout.source_url string

Source url.

layout.multiple_sources boolean

Multiple sources.

layout.source_name_2 string

Source name.

layout.source_url_2 string

Source url.

layout.source_name_3 string

Source name.

layout.source_url_3 string

Source url.

layout.source_label string

Source label.

layout.footer_note string

Note.

layout.footer_note_secondary string

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

layout.footer_logo_enabled boolean

Image.

layout.footer_logo_src url

Image.

layout.footer_logo_src_light hidden

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

layout.footer_logo_link_url string

Link.

layout.footer_logo_height number

Height.

layout.footer_logo_margin number

Margin.

layout.footer_logo_order string

Position.

layout.footer_align_vertical string

V. align.

layout.footer_border string

layout.footer_border_width number

Width.

layout.footer_border_color color

Color.

layout.footer_border_style string

Style.

layout.footer_border_space number

Space. Space between border and footer text

Accessibility

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.)

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 no replicate your title, since that will also be read by screenreaders.