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: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

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/hierarchy",
    version: "4",
    bindings: {
        data: {
            
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@flourish/hierarchy",
    version: "4",
    bindings: {
        data: {
            nest_columns: [0, 1, ...], // index(es) of column(s) in your data
            size_columns: [2, 3, ...], // index(es) of column(s) in your data
            filter: 4, // index of a column in your data
        }
    },
    data: {
        data: [
            [ "DataColumn1Value1", "DataColumn2Value1",
            [ "DataColumn1Value2", "DataColumn2Value2",
            [ "DataColumn1Value3", "DataColumn2Value3",
            ...
        ]
    }
}

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:

{
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }

... 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/hierarchy",
    version: "4",
    bindings: {
        data: {
            
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/hierarchy",
    version: "4",
    bindings: {
        data: {
            nest_columns: ["DataHeader1", "DataHeader2", ...],
            size_columns: ["DataHeader3", "DataHeader4", ...],
            filter: "DataHeader5",
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

(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/hierarchy",
    version: "4",
    data: {
    data: [
        {
            nest_columns: [...],
            size_columns: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/hierarchy",
    version: "4",
    data: {
    data: [
        {
            nest_columns: [...],
            size_columns: [...],
            filter: ...
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

• data.nest_columns: Choose categorical columns to nest by (e.g. Lead Studio, Genre).
• data.size_columns: (Optional) Choose numeric columns to size by (e.g. Worldwide Gross). If more than 1 is chosen, a dropdown will appear in the visualisation which lets the user choose. Rows with negative values are excluded.
• data.filter: (Optional) Choose categorical columns to filter by. A dropdown will appear in the visualisation.

Template settings

Options for opts.state.

Hierarchy

hierarchy_layout string

Layout. Choose between a treemap, packed circles, radial sunburst, stacked bar or radial tree chart

num_of_visible_levels number

Visible levels. How many hierarchy levels are visible at once?

sort_by string

Sort by. Sort cells by value or by name.

aggregation_type string

Size cells by.

Colours

color.palette colors

Palette.

color.extend boolean

Auto-extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once. Added colours are based on the average lightness and chroma values of the palette. This works best if the palette’s colours do not have very high or low saturation.

color.advanced boolean

Fine tune. Fine tune how additional colours are added to the palette.

color.hue_rotation_angle number

Hue rotation for added colours. Angle, in degrees in HCL colourspace, between one generated colour and the next. The default value, ~360/(Golden ratio), ensures adjacent hues are not too similar.

color.custom_palette text

Custom overrides. Type the name of the entity whose colour you want to set, a colon and then a colour (using a name, hex-code or rgb declaration). Multiple colours can be set using multiple lines. For example:

---

Party 1: red
Party 2: #4455AA
Party 3: rgb(30,168,26)

zoom_out_button_color color

Button colour.

zoom_out_arrow_color color

Arrow colour.

label_color color

radial_tree_colored_links boolean

Coloured links. Use coloured links

radial_tree_link_color color

Radial tree link colour.

Treemap

treemap_type string

Layout mode.

treemap_ratio number

Target. The target ratio between width and height, where 1 is sqaure and a large number is a tall or wide rectangle

cellPadding string

Padding. Add padding between hierarchy levels

Sunburst

sunburst_inner_radius number

Inner radius. As a % of total radius

sunburst_depth_fade number

Depth fade. How quickly the segments fade with hierachical depth. (Use 1 for no fade.)

sunburst_labelling string

Labels. How the labels should be oriented

sunburst_bold_labels boolean

Bold labels. Label font is bold

Bar

bar_bar_thickness number

Bar thickness. Bar thickness in pixels

bar_bar_padding number

Bar padding. Distance between bars in pixels

bar_axis_label_size number

Axis width. How wide the axis label area is

bar_show_value_label boolean

Show value label.

bar_value_label_size number

Space for value labels.

bar_max_value number

Maximum value. The maximum value represented by bar length (leave blank for auto-scaling)

Radial Tree

radial_tree_outer_radius number

Outer radius (%). Radius of outer nodes (as a percent of the container size)

radial_tree_bar_length number

Bar length (%). Bar length (as a percent of the container size)

radial_tree_bar_width number

Bar width (pixels). Bar width in pixels

radial_tree_rotation number

Rotation (degrees). Rotates the whole tree

radial_tree_show_values boolean

Show value labels.

Popups

popup.show_popups boolean

Popups.

popup.is_custom boolean

Popup contents.

popup.custom_template text

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

popup.show_pointer boolean

Pointer.

popup.show_shadow boolean

Shadow.

popup.style_popups boolean

Custom styling.

popup.text_color color

Text colour.

popup.align string

Alignment.

popup.font_size number

Font size.

popup.fill_color color

Fill colour.

popup.opacity number

Fill opacity.

popup.padding number

Padding.

popup.border_radius number

Radius. Corner radius of popup

popup_show_title boolean

Mode.

popup_separator string

Title separator.

popup_title string

Title. Popup title (leave blank to show breadcrumb)

number_formatter.prefix string

Prefix. Text to place in front of number

number_formatter.suffix string

Suffix. Text to place after number

number_formatter.n_dec number

Decimal places. Use negative integers to round to positive powers of ten (eg -2 rounds to the nearest 100)

number_formatter.strip_zeros boolean

Remove trailing zeros.

number_formatter.strip_separator boolean

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

number_formatter.transform_labels boolean

Multiply/divide values.

number_formatter.transform string

number_formatter.multiply_divide_constant number

number_formatter.exponentiate_constant number

Controls

controls_padding number

Padding.

control_width number

Width.

filter_type string

Filter type.

filter_include_all boolean

Include "All" in filter.

filter_all_label string

"All" label.

Animations

animation_duration number

Duration. In seconds

Number formatting

localization.input_decimal_separator string

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

localization.output_separators string

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

Layout

Layout

layout.body_font font

Font.

layout.max_width number

Maximum width. Leave blank to stretch to container width

layout.margin number

Margin.

layout.background_color_enabled boolean

Color.

layout.background_image_enabled boolean

Image.

layout.background_color color

Color.

layout.background_image_src url

Image URL.

layout.background_image_size string

Size.

layout.background_image_position string

Position.

layout.layout_order string

Layout order.

layout.space_between_sections string

Space between sections.

layout.space_between_sections_custom number

Custom.

Header

layout.header_align string

Alignment.

layout.title string

layout.title_styling boolean

Change title styles.

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.subtitle string

layout.subtitle_styling boolean

Change subtitle styles.

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.text string

layout.text_styling boolean

Change text styles.

layout.text_size string

Size.

layout.text_size_custom number

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

layout.text_weight string

Weight.

layout.text_color color

Color.

layout.text_line_height number

Line height.

layout.text_space_above string

Space above.

layout.text_space_above_custom number

Custom.

Footer

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.note string

Note.

layout.size number

Size.

layout.color color

Color.

layout.footer_align string

Alignment.

layout.logo_url url

Image.

layout.logo_link_url string

Link.

layout.logo_height number

Height.

layout.logo_margin number

Margin.

layout.logo_order string

Position.

layout.footer_align_vertical string

V. align.