Sports

A sports visualization to map a player's positions on a field/court

Updated 6 days ago to v7.3.0 by Flourish team

How to use this template

What's it for?

Use this template to visualise team line ups on a field or court. You can use it to show a formation, or to map the specific position of players over time

How to get started

  1. The first thing you need is a CSV or Excel file of your data.
  2. You need to make sure that there’s a row for each "player" in your team. This should plot the players on the field.
    Name
    Lieke Martens
    Lionel Messi
  3. Additionally, you can have columns, for the player's team, photo, x and y position, and metadata to show in a popup. It's also possible to add an arbitrary value to size the player's circle, or add a filter.
  4. Here's an example:
    Name Team Photo x y Goals
    Lieke Martens Barcelona martens.png 45 87 4
    Lionel Messi Barcelona messi.png 54 79 9

Not sure how to upload your data to Flourish? See our handy guide

Credits

This template was created by the Flourish team. Want to see additional features? Let us know at support@flourish.studio.

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/sports

version: 7

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: {
        positions: [
            [ "PositionsColumn1Value1", "PositionsColumn2Value1",
            [ "PositionsColumn1Value2", "PositionsColumn2Value2",
            [ "PositionsColumn1Value3", "PositionsColumn2Value3",
            ...
        ]
    }
}

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/sports",
    version: "7",
    bindings: {
        positions: {
            
        }
    },
    data: {
        positions: [
            [ "PositionsColumn1Value1", "PositionsColumn2Value1",
            [ "PositionsColumn1Value2", "PositionsColumn2Value2",
            [ "PositionsColumn1Value3", "PositionsColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@flourish/sports",
    version: "7",
    bindings: {
        positions: {
            info: [0, 1, ...], // index(es) of column(s) in your data
            color: 2, // index of a column in your data
            size: 3, // index of a column in your data
            squad_number: 4, // index of a column in your data
            position_x: 5, // index of a column in your data
            position_y: 6, // index of a column in your data
            filter: 7, // index of a column in your data
            photo: 8, // index of a column in your data
            metadata: [9, 10, ...], // index(es) of column(s) in your data
        }
    },
    data: {
        positions: [
            [ "PositionsColumn1Value1", "PositionsColumn2Value1",
            [ "PositionsColumn1Value2", "PositionsColumn2Value2",
            [ "PositionsColumn1Value3", "PositionsColumn2Value3",
            ...
        ]
    }
}

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:

{
        positions: [
            { "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
            { "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
            { "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
            ...
        ]
    }

... 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/sports",
    version: "7",
    bindings: {
        positions: {
            
        }
    },
    data: {
        positions: [
            { "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
            { "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
            { "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/sports",
    version: "7",
    bindings: {
        positions: {
            info: ["PositionsHeader1", "PositionsHeader2", ...],
            color: "PositionsHeader3",
            size: "PositionsHeader4",
            squad_number: "PositionsHeader5",
            position_x: "PositionsHeader6",
            position_y: "PositionsHeader7",
            filter: "PositionsHeader8",
            photo: "PositionsHeader9",
            metadata: ["PositionsHeader10", "PositionsHeader11", ...],
        }
    },
    data: {
        positions: [
            { "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
            { "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
            { "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
            ...
        ]
    }
}

(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/sports",
    version: "7",
    data: {
    positions: [
        {
            info: [...],
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@flourish/sports",
    version: "7",
    data: {
    positions: [
        {
            info: [...],
            color: ...,
            size: ...,
            squad_number: ...,
            position_x: ...,
            position_y: ...,
            filter: ...,
            photo: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

  • positions.info: For example the player's name string, number
  • positions.color: color string
  • positions.size: Use this column to adjust the size of the circle number
  • positions.squad_number: Optional squad number to appear within circle number, string
  • positions.position_x: Use this to move the player to a specific position on the pitch. Make sure to set the player's position setting to "Positions from data" number
  • positions.position_y: Use this to move the player to a specific position on the pitch. Make sure to set the player's position setting to "Positions from data" number
  • positions.filter: Setting a column here will add a control to the visualization to filter the players. You could use this for example on a time or country column. string, number
  • positions.photo: Point to column with image URLs string
  • positions.metadata: One or more columns of information to include in popups and panels. string, number, datetime

Template metadata

Note: metadata is optional, and the API will interpret your data for you if you do not specify it. A typical example of when specifying metadata can be useful is when column(s) in your data contain numbers or dates that you wish to format visually (e.g. to display a column containing MM/DD/YYYY dates in DD/MM/YYYY format).

This template supports an optional metadata property. metadata informs the template what type of data is in each of your columns, and how that data should be formatted visually.

You can specify metadata in one of three formats, depending on the format of opts.data.

1. Array of objects with column indexes as keys

You should supply metadata in this format when opts.data is in the previously described 'array of arrays' format. In this case, metadata should be an object with column index: column type object key/value pairs (column type objects must have type, type_id, and output_format_id keys, documented below):

{
    template: "@flourish/sports",
    version: "7",
    ...
    data: {
        positions: [
            [ "PositionsColumn1Value1", "PositionsColumn2Value1",
            [ "PositionsColumn1Value2", "PositionsColumn2Value2",
            [ "PositionsColumn1Value3", "PositionsColumn2Value3",
            ...
        ]
    },
    metadata: {
        positions: {
            0: { type: ..., type_id: ..., output_format_id: ... },
            1: { type: ..., type_id: ..., output_format_id: ... },
            2: { type: ..., type_id: ..., output_format_id: ... },
        }
    },
    ...
}

2. Array of objects with column headers as keys

You should supply metadata in this format when opts.data is in the previously described 'array of objects with arbitrary keys' format. In this case, metadata should be an object with column header: column type object key/value pairs (column type objects must have type, type_id, and output_format_id keys, documented below):

{
    template: "@flourish/sports",
    version: "7",
    data: {
        positions: [
            { "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
            { "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
            { "PositionsHeader1": ..., "PositionsHeader2": ..., ... },
            ...
        ]
    },
    metadata: {
        positions: {
            "PositionsHeader1": { type: ..., type_id: ..., output_format_id: ... },
            "PositionsHeader2": { type: ..., type_id: ..., output_format_id: ... },
            "PositionsHeader3": { type: ..., type_id: ..., output_format_id: ... },
        }
    },
    ...
}

Column type objects:

Column type objects tell the API what type of data is in a column:

{
    type: "number", // options also include 'string', and 'datetime'
    type_id: "number$comma_point", // numbers in the format 13,429.17
    output_format_id: "number$space_comma", // numbers in the format 13 429,17
}

For more information on valid column type values, see Recognized Type Formats.

Template settings

Options for opts.state.

Pitch

positions_type string

Position points by. Position points automatically based on your data, on a specific formation, or use X and Y coordinates

Allowed values:

  • auto (Auto)
  • formation (Formation)
  • data (Coordinates)

positions_scale_custom string

Position scale. "Auto" will set the position scale based on the minimum and maximum values in your data. "Custom" allows you to set a custom minimum and maximum.

Allowed values:

  • auto (Auto)
  • custom (Custom)

positions_x_min number

X min.

positions_x_max number

X max.

positions_y_min number

Y min.

positions_y_max number

Y max.

formation_type string

Formation type.

Allowed values:

  • preset (Preset)
  • custom (Custom)

formation string

Formation.

Allowed values:

  • --*-- ----- -***- *---* ----- -*-*- --*-- ----- -*-*- (1-3-5-2)
  • --*-- ----- ----- ----- ----- **** ----- ----- ----- ----- -*--*--*- ----- ----- ----- -*-*- ----- -*- (1-4-3-3)
  • --*-- -*-*- *---* --*-- -*-*- *---* --*-- (1-4-3-2-1)
  • -*- - -**- *--* ---- -**- *--* - - -*--*- (1-4-4-2)
  • -*- -- -*-*-*- -- *-*-*-* -- -*---*- -*- -- (1-3-4-3)
  • -*- - **** - -*-*- - -*----*- --*-- - -*- - (1-4-2-3-1)

formation_custom code

Custom formation. Use a "*"" for every player and a "-" for every space on the pitch

pitch.margin_top number

Top.

Max: 1

pitch.margin_bottom number

Bottom.

Max: 1

pitch.type string

Sport.

Allowed values:

  • football (Football)
  • basketball (Basketball)
  • tennis (Tennis)
  • custom (Custom)

pitch.type_custom string

Allowed values:

  • upload (Upload)
  • svg (Write)

pitch.type_upload url

Upload.

pitch.type_svg text

SVG.

pitch.line_color color

Color.

pitch.line_opacity number

Opacity. Opacity of the pitch marking lines

Max: 1

pitch.line_width number

Line width. Line width of the pitch markings in pixels

pitch.height number

Pitch height. As a percentage of the width

pitch.background color

Background color. Background color of the pitch

pitch.opacity number

Opacity. Opacity of the pitch background

Max: 1

pitch.orientation string

Orientation.

Allowed values:

  • vertical (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAArCAYAAADhXXHAAAAACXBIWXMAABcRAAAXEQHKJvM/AAAAh0lEQVRYhe3ZwQnDMBAF0d3gAlJKOkhLLsWluZR08IPBBVigOQhmzkL7DjppO0mt0msZqVgwsVTbyMXdfVTVZyLmTLI/PTyEvaHfcdOcfLNUYqnEUomlEksllkoslVgqsVRiqcRSiaUSSyWWains0AKku69fxPfE+b8k5+P5bmugxFKtg62qP2WGE75pnTIQAAAAAElFTkSuQmCC)
  • horizontal (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAAAfUlEQVRYhe3YwQnDMBAF0a/gwlRaSkkpLiWdrHGOiY4Tm4UZ2Mvq8g4CgUZVpUOPFkqhf0gonVA6oXRtoNtqOcaYSeb1nE/vqnr9bM+3/nuSPM+jm2ZfmbyjdELphNIJpRNKJ5ROKJ1QOqF0baD+j9IJpRNKJ5ROKF0PaJID9nNIU8M9hD8AAAAASUVORK5CYII=)

pitch.crop string

Crop pitch. Show the full pitch, or only show a portion

Allowed values:

  • 1 (Full)
  • custom (Custom)

pitch.crop_custom number

Custom.

Min: 0.05

Max: 1

pitch.flip_dots boolean

Flip dots.

Allowed values:

  • true (On)
  • false (Off)

pitch.flip_pitch boolean

Flip pitch.

Allowed values:

  • true (On)
  • false (Off)

Dots

colors.categorical_palette colors

Palette.

colors.categorical_extend boolean

Extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once

colors.categorical_custom_palette text

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

colors.numeric_type string

Scale type.

Allowed values:

  • sequential (Sequential)
  • diverging (Diverging)

colors.binning boolean

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

Allowed values:

  • false (Linear)
  • true (Binned)

colors.bin_mode string

Binning mode.

Allowed values:

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

colors.bin_count number

Number of bins.

colors.bin_thresholds string

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

colors.sequential_palette string

Palette.

Allowed values:

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

colors.sequential_reverse boolean

Reverse.

colors.sequential_custom_min color

Minimum color.

colors.sequential_custom_max color

Maximum color.

colors.sequential_color_space string

Color space.

Allowed values:

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

colors.sequential_custom_domain boolean

Domain.

Allowed values:

  • false (Auto)
  • true (Custom)

colors.sequential_domain_min number

Min.

colors.sequential_domain_max number

Max.

colors.diverging_palette string

Palette.

Allowed values:

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

colors.diverging_reverse boolean

Reverse.

colors.diverging_custom_min color

Minimum color.

colors.diverging_custom_mid color

Midpoint color.

colors.diverging_custom_max color

Maximum color.

colors.diverging_color_space string

Color space.

Allowed values:

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

colors.diverging_custom_domain boolean

Domain.

Allowed values:

  • false (Auto)
  • true (Custom)

colors.diverging_domain_min number

Min.

colors.diverging_domain_mid number

Mid.

colors.diverging_domain_max number

Max.

dot_opacity number

Opacity. Opacity of the dots

Max: 1

dot_size string

Size.

Allowed values:

  • 1 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAArCAYAAADhXXHAAAAACXBIWXMAABcRAAAXEQHKJvM/AAAA9UlEQVRYhe2Y0Q2CQAyG/xoHYAQ3EDdwFN3AERiBERzBEXSDG8ERYILfXHL3JhFoa0LSL+kLubQfDfTghCS2wm4zpiHrSMh6EbJehKwXIetFyHqxKdm9ZTIRaQC0AM4AngASycGsQP6etQgAXU73JXoAjUkNI9H7hGiNZCFsIXr5IVqj09ZS/9aISO7accbSkWSjqmUguyTBiWRaW+vfo0vVWQvZccHa1V2Fkexj5rqXeuYaTIMDgGHGNGi1tdSdJfkuO9bU45CvXzUvVsXsRKZstbciXsmCfbkhfY04PnIiZL0IWS9C1ouQ9SJkvQhZL0LWBQAfiJniv9QiqF0AAAAASUVORK5CYII=)
  • 2.5 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAABOUlEQVRYhe2YYY3DMAyF3zsCG4Qeg0IYhEEohIMwKIXQMTgIhRAIY+CTpXSqdjotTryeqvlJ/lU3+RLHtRuKCPagj11QBugLFKDeClBvBai33guU5EByJDmTlGyJ5JSfHZsn0VpfawDOAJIO88RuAL6a5mqAHAsAH20CcNwMtBJysXkTUA1hA+RiF+u8pn40J4WeyUNzcgCfIpJKna1ZPzhBqi4W5xpQL50s41hD7/3fUhz+4h11+Wj/VlfqaAl98aCvUDGoiMz/CWo9ozfHrNfFs9TXmvWTHedPXS3OVtCxne8u26IrSui3Qwk11/sa0C63bbWQ+m6/VffUN8AOm7V5K9jZAJhqdrIZdAU8PAFOuQGpapgXc7t2JKlnt1s1GwqfvApF3I96K0C9FaDeClBvBai39gEK4AcpHn6mz53bbgAAAABJRU5ErkJggg==)
  • 6 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAArCAYAAADhXXHAAAAACXBIWXMAABcRAAAXEQHKJvM/AAABiElEQVRYhe2Z722DMBDFn6t+TzYonaCMwAgdISN0BEboCIzACIxANsgI7gRXWTokFJ0t/7eIeNL7EiH7x4WDe6CICEfR22FIT9iCes+9tFKqA2CsiWjNunZKgymlrgC+2T2AD+GwPwALeyaiR/SGBjbUXLnJVM8sEejZnFjUvhGgYyTks38BXIvAmoX5r0yF3HsNqXII6JoZdLP2BW4NugfucsDOhUE3r0mwfEuqAbp5TIF9VIYl1+XgAr01ADWeYmBLN5XN2nb/FQcZfr5/RT8W03QBMEgr2KYu8eCKCoLtG8OK+78EbGtdjgQr6iVgdWWOZ92lH22wWbNThMToY4NdGsOK+1sDo1JK27qygj6lYOlqsLkR6N2agB2DTNdokLnFzrNTZVBnWvDJXzlit6+dwdEngw2VQH+SA2Ol1GBNB8GwhYG9QINgd5dErhCpXZ2fDLtrujG1mj4vNZJhd9AdQ/tWWsdCbs7yAYQD5sAnYCrf8zCk2UuOF8vn15pSOmFL6TiwAP4B+BrlUYlYLccAAAAASUVORK5CYII=)
  • custom (...)

dot_size_custom number

Custom.

Max: 10

dot_border string

Border size.

Allowed values:

  • 0 (None)
  • 0.25 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAArCAYAAADhXXHAAAAACXBIWXMAABcRAAAXEQHKJvM/AAAB8UlEQVRYhe2Y7W2DMBCG36v6P3SCsEEZoSOwQTMCIzBCR2CEdAOyAd2AbpANrnJj1NOJ4A/sSpH8SlYcY58fzl9niJnxKHp6GNICm1EFNpcKbC49pzJMRDUAk95E8QhgZuY5SSfmUIhNACoAHYDJmNpIBrY39Xf1twO0BXB1QOpk6nexfUYdt0Q0AHhXxV922I2XZ+v1xr7Uq6r7CeDEzNes0wDAoLxlAN8cbcxcPqt2U+i0CAX9UB0GDanxppo6QxZYu8ol6ClyrjfKTpsDdhQd9LGLxNrqhK05KazyqrfxgJf3GiXfE+wk8n3QCr4vaaf1aeC1dRGR2YqO9u9L8JZz366xc8BtVyJXfV/PLqCXVKBW45IhosZV2QlLRFUarlVNotDZj49na5FPE5BEygnLzPLt642qMQoatdB4NjWsDCenjXq/8oW92N+jz0LwkY1/lwDn22fh+sKeRb5LAav27vNGvT95njaVCkCanadXrezVqWODfk94p2xNMZFXSAeV3bri49GbDRkPX0NshHqkUcM3uwJv1Vbf1bzaRsHeAV5uC+2al2y5vl1ExcOxc27NS9Lbo5oy+nnUAo2CFdDdBtTazXbXdTzJx2Qiau1p1Nh0sI8ui6eZedjdTwrY/1L5MJdLBTaXCmwuFdgsAvADB6fbpSIV7VIAAAAASUVORK5CYII=)
  • 0.5 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAArCAYAAADhXXHAAAAACXBIWXMAABcRAAAXEQHKJvM/AAACDUlEQVRYhe2ZbW3DMBCGz9MABEIYLBACYWNQCIVQCIUQCGHQlEHHIGVQBjdZukpW7JzfcxxNlXqS/7TN+dl9vDl7jpnpVezjZUjfsDvaZw3XzrmWiHoiahNfz0R0Y+bb5o18g5UsATsLDANrlt+3xXuaHyBqiGgAAdfWUAJtBf0mosdG0Ofyfo67wEoKa0Au11AVtkLaqwAjoKedQWFg9XXrnPNydAGF5ZeIJi9T0vm+ETup8y/Qxw8zj0XSBcqSB+wzfrzMjWDTNeYyANNv62aiA6Amq+WgOc45PVhAA78dEIRkdDU91ZydSkAD/8eSjJVI1bwFNNhj0vrAAqs1VlH6E3v0WnQhWJEccz0VAmt9ESlMap7tFB28MvMD1EzEJsuP/3v41mbcfvmBFXa289QzK2zqJLDFGuXZKDApWK0ma8NGqQ4szuJKl2pq0FVSgjazT3SSWCuDq/IXH4tiGNtB+e7OzHBkc6/DTdGVqGoamxxmSlN02/JykOc1/8mRU3OYmz/NwODJeHX20Bwjo9ycG7wX/nIRXY2qCsu2E+0kY2UUafkcPXCOKg+QNiQay2hPhpua51KPNFlYsHNrrAeiMGhjdDsCQ6AwbBBha0kgJQNrNgwbQNe69Dibpc8KG0R5KCyNohtEzt3I5Mw514g09VLXqZuXu5TPKNJUfNJ4/7dmL3vD7mWvA0tEf7/PfCOn48QuAAAAAElFTkSuQmCC)
  • custom (...)

dot_border_custom number

Custom.

dot_border_color color

Color. Outline color of the dots

label_mode boolean

Labels. Labels will always be hidden if there are more than 200 data points

Allowed values:

  • true (On)
  • false (Off)

label_color color

Color. Label color. Defaults to layout font color settings if not set.

label_weight string

Weight.

Allowed values:

  • normal (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAAB7UlEQVRYhe2Y7U3DMBCG30P8pxsQJiAbkA3oBnQERkg3yAhlg4yQDYAN0g3aCQ6dOIvIclqf40SqyCtZrRLXfXy+D9vEzLgF3d0E5Qo6g1bQ3LrPNR4RbQCU3uOemfssfyDpKbUB2AI4CJAMNdLkXQ1gM+m/kn4EvF+BC7WTTGwRULWgFdBvSbDRlYmIxP8+L3Q56iScXkb6nQEUzHyazUcBdJ51nP8Vgb4bfReyaj330pf487edwZ990H72YBJAawSP+HVpGcOc8Jn5YPav3xTmy8+5F7VUZeoCzwrLAP+vhDoNSmmpkV/p5yRlASWirRYDgXvOMaavZFAiKjRPCuDDHHBDmUF1aRsAb1e6SgX60kAqIvrnA9Uy2o1YUMBafd8Nt3dEVC0GqpYMQZ61+rQJ+TVaFos2Achvieo5AZ2i8qgGjr90x6UgYUj4VeBZvRQkDKChcpfnLBSppUro5Mo0BTRq90NEu5Hdk02R+8lq5LA2ui9VK7YXzk6mXX6URZm50ygfSlJVLxbTHOssWBFRoz78OtmSA4hYq4aOFLGt03I6r0V1QmKljwRb7Jm5UjdIlimYmFkCYx/ZXSb1xMz1FECnpBtnrVRuDyrfH7Wc9rrMrX/nFLibMt1LrVfjubWC5tYKmlsraFYB+AHJbWT00E63yQAAAABJRU5ErkJggg==)
  • bold (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAArCAYAAADhXXHAAAAACXBIWXMAABcRAAAXEQHKJvM/AAAB6UlEQVRYhe2Y4W3CMBCF31X932xAOgHZoNmgjEAnKN2AEdgARmCDJhvQDdINYIKr3L5IFKX12dggpDzJyo+cfZ/s851tUVXciu5uhnSEzagRNpfuzx1YRCoANQD3LQdMdmxbVd2f5cylrtBGsA0A51yNzdkuARQxPr/9Bhn/zGATADjUdrHAVsgiAeRxiwIO2WDVWfH2W1MAq+BeASEwTzizfStzxmzncd5wia2wq5ywsxNney5nNRDjSwNslw2WIA1neG6wtQCbN1oMbGl1wBn2wdZW38EVTFU7nw2rWsG87FNh9Z2i3BaM5b7kurQUItdnmxVWROaEfI4dI1TBsCJS81wwuRRkr6Ajooi4NPV+DVCEwBL0NWDsA4CW3yQywXLpLaAfAN4APKqqS281K1oSWWN24fl/YJEw7epYWWF9O36mqk1OUFjCQESGrirH+rgEKIwx64P9swIxFz+FYw3LAuu75E0IdQrqDjHrVKCwxKyq7kTEZ7YWkQXLZn/bfUhGSVk3WGtYzmnEuSBI1qKwyQlhlQlWVTdM+DH6vCgsVUeUzpYx3AaTDcgMy6ef0ujYzeaLK7fslyQPR71886ww46xV3Pkt72buTWt7Yl/+k687y+0jGvZaGt9nc2mEzaURNpduBxbAF1QfOCr5pprUAAAAAElFTkSuQmCC)

label_size string

Size. Sizing unit is relative to root font size

Allowed values:

  • 0.8 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAArCAYAAADhXXHAAAAACXBIWXMAABcRAAAXEQHKJvM/AAABfUlEQVRYhe2Y4U3DMBCF36H+JxuQDdoNCBtkA2CDjsAGZYSyQUYIG5QNwgbpBIdOukpW6qBi3wVF8pPuR53U/mK/OzshZsZadLca0gLrqALrpQLrpQLrpVXBbiw6IaIKQAugAVAD2AG4B/AJYADQMXOXPZCcDVJDwY7SzQ3RA6iyxssAfbsRMoxTDuzSnt0S0UvyvzNtMOisjWqHJrgmFukiszssbgMFkqR6/82LwQOFUS8Om+HtJqUvk9I1lZayXRAmMoMlojaotQ9W/YbKhiUiWea9bgKuSobVpZZCv5255VuTS+LZ5CEyEqePJM6oCVUH9zX/mmBEJEnzOGn+UggBdlHqDtbG2jxBYXlEZOZh5pJZ6TKDJaJ9pE38e7AaI7UanCJtB/WyzPDlfGtbbzOqQWzPn4vRohrk2OBq2SM6A3idWYk/KxlWX1OetPhPJZAfklzMfLSCNfnkqV6tLr+Zuc/uNDaOBexSKt8NvFRgvVRgvVRgvVRgXQTgB3fqCdEckVWUAAAAAElFTkSuQmCC)
  • 1 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAAB50lEQVRYhe2Y0W2DMBCG76/6XjZoNmg6QekGbNCMkBGSDdINGCEjpBvQDegGbHDVSUeCUGzuwCBF4pfuxbHxZ/t85wuYmR5BTw9BuYLOoBU0tSaBAtgCOAC4AKgBcM8aAGcAu8ncEp48RkQZEe2JqJbhDpP+uXe+1ryQByJqnIB9280KOmIHY7b1gnp89DLZz246eQeYUyiADRFVRPTS++lPFyFWa9tW/fg18slPZrYvfoSPtkcqkxQD/cvI8ZdzXqZMdzUK2Osfuny1Z+7ZX08AZFe/AqcJ63eWyExBP5SEYf3IczKc2+Ry6cRybSoi3TPrdyeDKlihYPmdqJBEo0E1f0sIepsDrC83KIBCA3YsRiaXCzR2g+/oV9Nu4xgTliOGngbytwCV6q9ZZ1weGWN+TVkhY5OxZqwrnGOsGdR69PvIb+/MXE0+2gFZA34eaP9eApIcoKHYeE7IEtUSKXR6vZQANAgBIJPCLkloImN4GihDDr1wlOkCLLVV8vAUewBf35cj6qrkoJuJxVxod82gJh9lZtmp40jvOo4p5u5BpEyjXavaslh9dpHM1C5qrzdZLtBHoNuPFm5lp63S9r4a69yjayYJP1oWd1Uxs3ly13xzF3eptP4/mloraGqtoKn1GKBE9A+s6gavqYXpzgAAAABJRU5ErkJggg==)
  • 1.2 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAArCAYAAADhXXHAAAAACXBIWXMAABcRAAAXEQHKJvM/AAACVUlEQVRYhdVZ7U3DMBB9h/jfbkA3oBsQJqAjZISM0A0oG2SEskGYgGYCmg3KBIcsLlLUxvbFvkTwpFN/1HZe7s73FWJm/BfcW/Ikog0AJz0uzHwyOz9Vs0JsB6AAsAXwEFjeAWgA1MzcJLN1ZLUCYA2gAuC0xYlydi845bm96Bb9mrbOIDgmB1OyoklrkkOpTciKP15mJNpLZUF2sxBZ94yNhuxd4OK5i3BIvrl6rADss6OB+GxIu41Eh63HjZoJGl5nRwMA5YjZDlrTyctoyJZWoessB9YaDYzsPyrIHmPnqDIYERU5qVOy3VdkWcfMm9CCxQoZInIv+hhaw8wU+t8bDWZA1CpiwT9B9pJ7wFwlYiG/Tp6szs8iS0TrQZlYRMrEbEwmOyBYWmpNAzVZIVmJrJYk2UNFVm5pPbeZY4iSJSKnydfE8zvJfo34dJ7bGOX1XvpKbXedlqWyiu0PtjtezYrptRp9lzYlvRlUIOQGtWJ/J9XSrCR7jJIVrcYuUytmy85MWvjS7U6xv1qSKAJkt5F97VKmHyK1kDEbCU2Bj2wsHgaLZA9i1orCR/bDiqxL00TkXOZlLrIxPEhmixEtxGVsCh5P5tJkG5ZsddNASmrVNImTMthoD0ZEzr8+J7xzO+gE3N7Uquw5GGUU7feSEtRsyGfLRO348C01RDJCsy5njjcjoq24xzHrFMU0JXc+u7+6eMkXTDv+qRLGn/X1PEwGfbbRYAzSg5VS5PjiZiskjzIyvUFkkHEKFUc5X2u2oilYf0LyPnOpWZcFlhwf5QHAD3aCfbhzSy9iAAAAAElFTkSuQmCC)
  • custom (...)

label_size_custom number

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

Max: 10

show_squad_numbers boolean

Show Squad Numbers. Optional squad number to appear within dot

squad_number_size string

Size Mode. Resizes the font size as a proportion of the dots radius

Allowed values:

  • 1.1 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAArCAYAAADhXXHAAAAACXBIWXMAABcRAAAXEQHKJvM/AAABfUlEQVRYhe2Y4U3DMBCF36H+JxuQDdoNCBtkA2CDjsAGZYSyQUYIG5QNwgbpBIdOukpW6qBi3wVF8pPuR53U/mK/OzshZsZadLca0gLrqALrpQLrpQLrpVXBbiw6IaIKQAugAVAD2AG4B/AJYADQMXOXPZCcDVJDwY7SzQ3RA6iyxssAfbsRMoxTDuzSnt0S0UvyvzNtMOisjWqHJrgmFukiszssbgMFkqR6/82LwQOFUS8Om+HtJqUvk9I1lZayXRAmMoMlojaotQ9W/YbKhiUiWea9bgKuSobVpZZCv5255VuTS+LZ5CEyEqePJM6oCVUH9zX/mmBEJEnzOGn+UggBdlHqDtbG2jxBYXlEZOZh5pJZ6TKDJaJ9pE38e7AaI7UanCJtB/WyzPDlfGtbbzOqQWzPn4vRohrk2OBq2SM6A3idWYk/KxlWX1OetPhPJZAfklzMfLSCNfnkqV6tLr+Zuc/uNDaOBexSKt8NvFRgvVRgvVRgvVRgXQTgB3fqCdEckVWUAAAAAElFTkSuQmCC)
  • 1.4 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAAB50lEQVRYhe2Y0W2DMBCG76/6XjZoNmg6QekGbNCMkBGSDdINGCEjpBvQDegGbHDVSUeCUGzuwCBF4pfuxbHxZ/t85wuYmR5BTw9BuYLOoBU0tSaBAtgCOAC4AKgBcM8aAGcAu8ncEp48RkQZEe2JqJbhDpP+uXe+1ryQByJqnIB9280KOmIHY7b1gnp89DLZz246eQeYUyiADRFVRPTS++lPFyFWa9tW/fg18slPZrYvfoSPtkcqkxQD/cvI8ZdzXqZMdzUK2Osfuny1Z+7ZX08AZFe/AqcJ63eWyExBP5SEYf3IczKc2+Ry6cRybSoi3TPrdyeDKlihYPmdqJBEo0E1f0sIepsDrC83KIBCA3YsRiaXCzR2g+/oV9Nu4xgTliOGngbytwCV6q9ZZ1weGWN+TVkhY5OxZqwrnGOsGdR69PvIb+/MXE0+2gFZA34eaP9eApIcoKHYeE7IEtUSKXR6vZQANAgBIJPCLkloImN4GihDDr1wlOkCLLVV8vAUewBf35cj6qrkoJuJxVxod82gJh9lZtmp40jvOo4p5u5BpEyjXavaslh9dpHM1C5qrzdZLtBHoNuPFm5lp63S9r4a69yjayYJP1oWd1Uxs3ly13xzF3eptP4/mloraGqtoKn1GKBE9A+s6gavqYXpzgAAAABJRU5ErkJggg==)
  • 1.7 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAArCAYAAADhXXHAAAAACXBIWXMAABcRAAAXEQHKJvM/AAACVUlEQVRYhdVZ7U3DMBB9h/jfbkA3oBsQJqAjZISM0A0oG2SEskGYgGYCmg3KBIcsLlLUxvbFvkTwpFN/1HZe7s73FWJm/BfcW/Ikog0AJz0uzHwyOz9Vs0JsB6AAsAXwEFjeAWgA1MzcJLN1ZLUCYA2gAuC0xYlydi845bm96Bb9mrbOIDgmB1OyoklrkkOpTciKP15mJNpLZUF2sxBZ94yNhuxd4OK5i3BIvrl6rADss6OB+GxIu41Eh63HjZoJGl5nRwMA5YjZDlrTyctoyJZWoessB9YaDYzsPyrIHmPnqDIYERU5qVOy3VdkWcfMm9CCxQoZInIv+hhaw8wU+t8bDWZA1CpiwT9B9pJ7wFwlYiG/Tp6szs8iS0TrQZlYRMrEbEwmOyBYWmpNAzVZIVmJrJYk2UNFVm5pPbeZY4iSJSKnydfE8zvJfo34dJ7bGOX1XvpKbXedlqWyiu0PtjtezYrptRp9lzYlvRlUIOQGtWJ/J9XSrCR7jJIVrcYuUytmy85MWvjS7U6xv1qSKAJkt5F97VKmHyK1kDEbCU2Bj2wsHgaLZA9i1orCR/bDiqxL00TkXOZlLrIxPEhmixEtxGVsCh5P5tJkG5ZsddNASmrVNImTMthoD0ZEzr8+J7xzO+gE3N7Uquw5GGUU7feSEtRsyGfLRO348C01RDJCsy5njjcjoq24xzHrFMU0JXc+u7+6eMkXTDv+qRLGn/X1PEwGfbbRYAzSg5VS5PjiZiskjzIyvUFkkHEKFUc5X2u2oilYf0LyPnOpWZcFlhwf5QHAD3aCfbhzSy9iAAAAAElFTkSuQmCC)
  • custom (...)

squad_number_size_custom number

Custom. Specify a custom responsive font size. Best results are betwen 0.8 and 2.

Max: 10

squad_number_weight string

Weight.

Allowed values:

  • normal (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAAB7UlEQVRYhe2Y7U3DMBCG30P8pxsQJiAbkA3oBnQERkg3yAhlg4yQDYAN0g3aCQ6dOIvIclqf40SqyCtZrRLXfXy+D9vEzLgF3d0E5Qo6g1bQ3LrPNR4RbQCU3uOemfssfyDpKbUB2AI4CJAMNdLkXQ1gM+m/kn4EvF+BC7WTTGwRULWgFdBvSbDRlYmIxP8+L3Q56iScXkb6nQEUzHyazUcBdJ51nP8Vgb4bfReyaj330pf487edwZ990H72YBJAawSP+HVpGcOc8Jn5YPav3xTmy8+5F7VUZeoCzwrLAP+vhDoNSmmpkV/p5yRlASWirRYDgXvOMaavZFAiKjRPCuDDHHBDmUF1aRsAb1e6SgX60kAqIvrnA9Uy2o1YUMBafd8Nt3dEVC0GqpYMQZ61+rQJ+TVaFos2Achvieo5AZ2i8qgGjr90x6UgYUj4VeBZvRQkDKChcpfnLBSppUro5Mo0BTRq90NEu5Hdk02R+8lq5LA2ui9VK7YXzk6mXX6URZm50ygfSlJVLxbTHOssWBFRoz78OtmSA4hYq4aOFLGt03I6r0V1QmKljwRb7Jm5UjdIlimYmFkCYx/ZXSb1xMz1FECnpBtnrVRuDyrfH7Wc9rrMrX/nFLibMt1LrVfjubWC5tYKmlsraFYB+AHJbWT00E63yQAAAABJRU5ErkJggg==)
  • bold (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAArCAYAAADhXXHAAAAACXBIWXMAABcRAAAXEQHKJvM/AAAB6UlEQVRYhe2Y4W3CMBCF31X932xAOgHZoNmgjEAnKN2AEdgARmCDJhvQDdINYIKr3L5IFKX12dggpDzJyo+cfZ/s851tUVXciu5uhnSEzagRNpfuzx1YRCoANQD3LQdMdmxbVd2f5cylrtBGsA0A51yNzdkuARQxPr/9Bhn/zGATADjUdrHAVsgiAeRxiwIO2WDVWfH2W1MAq+BeASEwTzizfStzxmzncd5wia2wq5ywsxNney5nNRDjSwNslw2WIA1neG6wtQCbN1oMbGl1wBn2wdZW38EVTFU7nw2rWsG87FNh9Z2i3BaM5b7kurQUItdnmxVWROaEfI4dI1TBsCJS81wwuRRkr6Ajooi4NPV+DVCEwBL0NWDsA4CW3yQywXLpLaAfAN4APKqqS281K1oSWWN24fl/YJEw7epYWWF9O36mqk1OUFjCQESGrirH+rgEKIwx64P9swIxFz+FYw3LAuu75E0IdQrqDjHrVKCwxKyq7kTEZ7YWkQXLZn/bfUhGSVk3WGtYzmnEuSBI1qKwyQlhlQlWVTdM+DH6vCgsVUeUzpYx3AaTDcgMy6ef0ujYzeaLK7fslyQPR71886ww46xV3Pkt72buTWt7Yl/+k687y+0jGvZaGt9nc2mEzaURNpduBxbAF1QfOCr5pprUAAAAAElFTkSuQmCC)

squad_number_color color

Color.

squad_number_vertical_adjust number

Adjust vertical spacing. Adjust vertical centering for custom fonts

Min: -1

Max: 1

image_contrast number

Contrast.

image_brightness number

Brightness.

image_saturation number

Saturation.

Max: 1

image_blend_mode string

Blend mode.

Allowed values:

  • normal (None)
  • multiply (Multiply)
  • screen (Screen)
  • overlay (Overlay)
  • darken (Darken)
  • lighten (Lighten)

Animation & trail lines

animation_target string

Animate. Choose whether you want to animate the animate the positions or fade, for example when changing the filter, or drag players' positions in the story editor

Allowed values:

  • position (Position)
  • opacity (Fade)
  • both (Both)

animation_duration number

Duration. Specified in seconds

trail boolean

Trail lines. Show trail lines when a point is dragged to a new position. Only visible in the story editor.

Allowed values:

  • false (Disabled)
  • true (Enabled)

trail_color color

Color.

trail_opacity number

Opacity.

Max: 1

trail_size string

Size.

Allowed values:

  • 0.25 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAABX0lEQVRYhe2Y4W2DMBCF31X9X0Zgg3aEjJAR2g06QkfoCBkhIzACI5AN6ASvsmQkBBjbwZyNxJPuj8WFT89n3xEhiSPo5RCUJ+gOetV+oYhUAK4AarvUA7iT7FYTzWHSCgA/5pWOuAOoXCyakO0K5BDG3XopX6VGReQXwHvAo2/W2bkUnKwDnJzGZw5HrylyNECrFDlnZ0otDdDlUxybo3SHNhEnvl+6+LW2/hvAX+izJPvZ6o4uVuO2COADQOdxcnZ/7tpCLeTQMtvxVhoYWwqdhWvsDODs8yaST/h2OmomLfNBsl5J8yppjTogYR3bpp22exzOuov6/SNAJgHVgNwMqgW5CVQT8mlQbcinQHNARoPmgowCzQkZDJobMgi0BEgvaCmQq6AlQTpBS4Ok61PEfgq0k+UvkrdEE2G8PDV6y+3kEN4JX0QuJJtsTg4cPtBSdP5TklonaGodAxTAP0aY+pAL8TnCAAAAAElFTkSuQmCC)
  • 0.5 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAArCAYAAADhXXHAAAAACXBIWXMAABcRAAAXEQHKJvM/AAABTUlEQVRYhe3Y0QmDMBAA0LvS/zqCI9gNHMEROoojOIIjtBs4giM4QjvBlYNYJBiTKLlLwYNAOUx8DTZnD4kI/iUufyM9sQnjqnFTRKwAoFmkRiJ6eifyD0xqAAAjR77tynjzF9iySEIbB9IenSoWAEqzcyFYcu2wFLaPgPKY1tYRKQqIyLt6i5x2J6JxmZA6umKhHIWdOCtYqpDCviKv/xDRYCeTYhGxNB+7yKnr1yc+rqYdxxefAIXYOWvB2kW+80AHFzQJ1rGDD6ua9QY27yS/xNTetQUrVXt4fSHo73lUxwZCueRWqlgp6GGsJPQQVhq6G6sB3YXVgkZjNaFRWG1oMDYHaBA2F6gXmxN0E5sb1IkNeO8Uh25hK08HRRzqewxcYBXoJtYBVoNSSPvI9FLnv8W13dKRjKBelwGDJhRCsbnE2T5KFSc2SQDAF0tYdAWoJCThAAAAAElFTkSuQmCC)
  • custom (...)

trail_size_custom number

Custom. Proportional to the smallest point size

Max: 1

trail_style string

Style.

Allowed values:

  • solid (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAArCAYAAADhXXHAAAAACXBIWXMAABcRAAAXEQHKJvM/AAAAX0lEQVRYhe3YsQkAIAwF0a84uKO5WVzB5sDAPUh/xa8yqipdzDalxoKMpRhLMZZiLMVYirGknaQa3HYGFGMpxlKMpbSKXUnOBx0vju8jirEUYynGUoylGEsxlmIsIskF80cxpsbOdPQAAAAASUVORK5CYII=)
  • dotted (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACoAAAArCAYAAAAOnxr+AAAACXBIWXMAABcRAAAXEQHKJvM/AAABa0lEQVRYhe1Y0Y2DMAy10Q3ACB2BEW4ERrgRGKEj3Ai9DRihI3QEugE3gU9GzgnSGEzrfiD5SZZKmsd7QS8OAokIjoDqEC7D6BsQRr0RRr0RRr0RRr0RRr1xGKMf+QAiNgBQ828iuu65GSIyr5HLgYiGnfykPRLRbfEnv4/KO2nLN+ehWY0AcE5ztAKAEwBcMi4XL7Qx8DvRyrW7/zky8VwQmddlw2QukguqZpUFPmgzPjcmpuoUoauBOyjc1qjdWlakikkeLdxJrMDvjdxpr+S5VEvJltXoQ9Z3cKlKO/xJvMLdBTZ6e4G/hzsWxu5G7r2SnFjwU5jD2fk18ks6Vu0po7U8mbWM8NM4rfTArYx9K9x6o7Ul7XpO0Myu9kFDHy6azDqHtqGHpL34UoKIX9Kz0ibppeGW8rUAInLj72ZHKC+8txzDcvS2M+1RtPukHZ90vBFGvRFGvRFGvRFGvRFGvRFGvRFGXQEAf7Vg6zeI+EdUAAAAAElFTkSuQmCC)

Legend

legend_categorical.show_legend boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

legend_categorical.title_mode string

Title mode.

Allowed values:

  • auto (Auto)
  • custom (Custom)

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 (<a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">in rems</a>)

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 (<a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">in rems</a>)

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:

  • horizontal (Horizontal)
  • vertical (Vertical)

legend_container.alignment string

Alignment.

Allowed values:

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

legend_container.orientation string

Orientation.

Allowed values:

  • horizontal (Horizontal)
  • vertical (Vertical)

legend_container.title_weight string

Title weight.

Allowed values:

  • bold (Bold)
  • normal (Normal)

legend_container.text_weight string

Text weight.

Allowed values:

  • bold (Bold)
  • normal (Normal)

legend_container.text_color color

Color.

legend_container.text_size number

Size.

Max: 10

Popups & panels

popup.mode string

Allowed values:

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

popup.popup_is_custom boolean

Popup content.

Allowed values:

  • false (Auto)
  • true (Custom)

popup.show_popup_styles boolean

Show popup styles.

popup.popup_custom_header html

Popup custom header. Use {{column_name}} to add a <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups">value from your data</a>. Ensure the column is selected, or add it to <b>Info for popups</b> for popup use. <br><br>Advanced users can add <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups#html">HTML</a> styling or <a href="https://help.flourish.studio/article/438-how-to-add-category-colors-to-popup-headers">add category colors</a> to popup headers. <br><br>To <a href="https://help.flourish.studio/article/490-how-to-add-conditional-statements-to-your-popups">hide parts of the popup</a> when a column is empty using <pre>{{#if column_name}}Content for non-empty column_name{{/if}}.</pre> For example: <pre>{{#if Capital name}}Capital:{{/if}} {{Capital name}}.</pre> Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.

popup.popup_custom_main html

Popup custom main content. Use {{column_name}} to add a <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups">value from your data</a>. Ensure the column is selected, or add it to <b>Info for popups</b> for popup use. <br><br>Advanced users can add <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups#html">HTML</a> for designs, styles, and images. <br><br>To<a href="https://help.flourish.studio/article/490-how-to-add-conditional-statements-to-your-popups"> hide parts of the popup</a> when a column is empty use the syntax <pre>{{#if column_name}}Content for non-empty column_name{{/if}}.</pre> For example: <pre>{{#if Capital name}}Capital:{{/if}} {{Capital name}}.</pre> Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.

popup.popup_custom_accessible text

Popup custom accessible content. A text alternative to visual custom popup content that will be read out by screenreaders. This content is added as an <code>aria-label</code> attribute to data point elements. You can still use {{column_name}} to add values from your data, but do not use HTML. For example: <code>{Name}}, Population: {{Population}}, GDP: {{GDP}}</code> If left empty, accessible content will fallback to the default popup content.

popup.popup_width number

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

popup.popup_font_size number

Text size.

popup.popup_text_color color

Text color.

popup.popup_align string

Align.

Allowed values:

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

popup.popup_background color

Fill color.

popup.popup_background_opacity number

Fill opacity.

Max: 1

popup.popup_padding number

Padding.

popup.popup_radius number

Radius. Corner radius of popup

popup.popup_header_type string

Header style.

Allowed values:

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

popup.popup_header_background color

Background.

popup.popup_header_text_color color

Text.

popup.popup_list_type string

List type.

Allowed values:

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

popup.popup_list_label_weight string

Label weight.

Allowed values:

  • normal (Normal)
  • bold (Bold)

popup.popup_list_separator string

List separator.

Predefined values:

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

popup.popup_shadow boolean

Shadow.

popup.popup_pointer boolean

Pointer.

popup.panel_position string

Allowed values:

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

popup.panel_open_duration number

Open duration.

Max: 2000

popup.panel_side_fixed boolean

Always show.

popup.panel_side_default_content text

Placeholder content.

popup.panel_is_custom boolean

Panel content.

Allowed values:

  • false (Auto)
  • true (Custom)

popup.show_panel_styles boolean

Show panel styles.

popup.panel_custom_header html

Panel custom header. Use {{column_name}} to add a <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups">value from your data</a>. Ensure the column is selected, or add it to <b>Info for popups</b> for panel use. <br><br>Advanced users can add <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups#html">HTML</a> for styling or <a href="https://help.flourish.studio/article/438-how-to-add-category-colors-to-popup-headers">add category colors</a> to panel headers. <br><br>To <a href="https://help.flourish.studio/article/490-how-to-add-conditional-statements-to-your-popups">hide parts of the panel</a> when a column is empty using <pre>{{#if column_name}}Content for non-empty column_name{{/if}}.</pre> For example: <pre>{{#if Capital name}}Capital:{{/if}} {{Capital name}}.</pre> Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.

popup.panel_custom_main html

Panel custom main content. Use {{column_name}} to add a <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups">value from your data</a>. Ensure the column is selected, or add it to <b>Info for popups</b> for panel use. <br><br>Advanced users can add <a href="https://help.flourish.studio/article/69-how-to-add-custom-content-to-your-popups#html">HTML</a> for designs, styles, <a href="https://help.flourish.studio/article/437-how-to-add-images-to-your-popups-and-panels">images, videos and <a href="https://help.flourish.studio/article/259-how-to-embed-charts-in-your-popups-or-panels#embedding-charts-in-your-popups">embedded Flourish charts</a>, <br><br>To <a href="https://help.flourish.studio/article/490-how-to-add-conditional-statements-to-your-popups">hide parts of the panel</a> when a column is empty using <pre>{{#if column_name}}Content for non-empty column_name{{/if}}.</pre> For example: <pre>{{#if Capital name}}Capital:{{/if}} {{Capital name}}.</pre> Here, the word "Capital:" will only show if the corresponding cell in the "Capital name" column is not empty.

popup.panel_width_overlay number

Width (%).

popup.panel_height_overlay number

Height (%).

popup.panel_width_side number

Width (%).

popup.panel_height_side number

Height (%).

popup.panel_max_width number

Max width (px).

popup.panel_max_height number

Max height (px).

popup.panel_vertical_position string

Vertical position. Choosing <b>Click position</b> is especially useful when your visualization is really tall, this will make sure the panel content is always on top of the element you've clicked on

Allowed values:

  • click (Click position)
  • center (Center)

popup.panel_text_color color

Text color.

popup.panel_font_size number

Text size.

popup.panel_align string

Alignment.

Allowed values:

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

popup.panel_background color

Fill color.

popup.panel_background_opacity number

Fill opacity.

Max: 1

popup.panel_padding number

Padding.

popup.panel_radius number

Radius. Corner radius of panel

popup.panel_list_type string

List type.

Allowed values:

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

popup.panel_list_label_weight string

Label weight.

Allowed values:

  • normal (Normal)
  • bold (Bold)

popup.panel_list_separator string

List separator.

Predefined values:

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

popup.panel_shadow boolean

Shadow.

Filter controls

controls_container.alignment string

Alignment.

Allowed values:

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

controls_container.controls_spacing number

Spacing. The space between controls, like dropdowns and adjacent button sets, in <a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">em</a> units.

Max: 5

filter_control.control_type string

Control type. Choose between a <b>dropdown</b>, <b>buttons</b> or a <a href="https://help.flourish.studio/article/524-how-to-add-a-time-slider-to-your-line-bar-pie-chart"><b>time slider</b></a>.

Allowed values:

  • dropdown (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAC0AAAAKCAYAAAFXtOeCAAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAALaADAAQAAAABAAAACgAAAAAWgdR+AAAAtklEQVQ4EdVV3QnEIAw25TbSB2foNI7iMu0MbuUR4ZOQy4OFCL2AmN8vMQallNLVez+DosNSsg/FGLtyDkR0H1rJMqOMiJxz4KWp1jpUsLNsptCBkD/MlFIgzx3IsD9GflTGTLvImN1ajP1x043dVrlr1fIY4xZZYd2kdATfWgu8NCEedtdWcJ+R1BVYnmIbsEzizW8bDO9CJd4cOijxCEH22DGIq1iyBiv2P8eDP4jVDrzE7/oCOyRFCckULykAAAAASUVORK5CYII=)
  • buttons (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACsAAAAKCAYAAAFaqpfFAAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAK6ADAAQAAAABAAAACgAAAACxtWN2AAAA5klEQVQ4EdVUwQ2DMAwkqBuFBzO0y2QUlqEz5AEzpTrUiyzLEEPbRy2F2D7n4tgWYRiGuZRy75T0lhMxIcZYoKzrWvUeDi0VTSlt2DRN9dQ4jh0WBP4avHneH3kF/SGE5w0GWXPOHRaFfrDiEW5mEJjBZJY7UoPNakjM0s0KWYFnfa6MUbRlWR573daXurLlhHDXJNreugan7D2D0K09YUeJy467no+D1iyRUO+u5+tDLdudaYuIOEcQtncMeba1/6QCrUuv4nWwJIE1ZBKHLgdJY0f2J9z/NQb4cRxV4iQ2y/hvc78ACNVvxtjAMtcAAAAASUVORK5CYII=)
  • slider (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACkAAAAKCAYAAAFeX0f4AAAABGdBTUEAALGPC/xhBQAAADhlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAKaADAAQAAAABAAAACgAAAABlifOxAAABz0lEQVQ4Ea1UvU7CUBSml05EHoBEB3gFGpg0fQE0Tk6suDC4uKBuxsXJ6BswGZaq0bnRqaR9CglPwEJCW79Dem5Of2iq8Sbk/H/349zTU7Msy6nhdLvdJUk+Ko7jk8RosbNcAupKZhjAjMkRBIHWG41GbTQayTzSP1IOIL32er3DlDMxTEI1DGPh+/4BSA7CMBxMp9N8LlAu2EtF+IVsS6m5maZpeZ4XcDApUGzX6/Wj+Xz+xXaZ1EWg59m2vSeSdYx8URRdili52u/394syqFlgu6TGFcV3+dRms/lGoS8TCAysP+FrUYN39U3WsG4mCmq2b3+Kt3cA9swJiVR4se1sZPw5kwEp8EBgpOD5fWJGOp/hcGiwXiap+atOp2MCTI8HZukY/ogLcUFqlNlfJHl8Vii6abfbj7PZrHDOuBiPNAH7W9hZxhFhgMwd5/6XZJIaDxeFIPHUbDavXddd6QAUmqJse2WcdNS/JV3Lhv5s50gyEi5bQB/jwhf2YcBoYZXuph3LhiF+LcHjXQ4kAQTYGudya0hUbIwzTL8LX+qjFznRer22MbyVtoqoK1UNPKGDy8cgRp2rdOi7p22Ep7eoAP/WV0rdV115lS4RST+YjrA2q0ehBQAAAABJRU5ErkJggg==)

filter_control.control_styles boolean

Adv..

filter_control.control_title string

Control title.

filter_control.button_group boolean

Grouped.

Allowed values:

  • true (On)
  • false (Off)

filter_control.button_group_width_mode string

Button group width.

Allowed values:

  • auto (Auto)
  • full (Full)
  • fixed (Fixed)

filter_control.button_group_width_fixed number

Width.

Max: 100

filter_control.dropdown_width_mode string

Dropdown width.

Allowed values:

  • auto (Auto)
  • full (Full)
  • fixed (Fixed)

filter_control.dropdown_width_fixed number

Width.

Max: 100

filter_control.slider_width number

Slider width. Width of the slider track in <a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">rems</a>

Max: 100

filter_control.slider_max_label_width number

Max label width. In <a href="https://help.flourish.studio/article/192-how-sizing-with-rems-works-in-flourish">rems</a>, multiples of base font size. If larger than the longest label, only the space required to fit labels will be used.

Max: 100

filter_control.slider_step_time number

Time between steps. Measured in seconds, positive values move the slider left to right, negative values move the slider right to left.

Min: -100

Max: 100

filter_control.slider_loop boolean

Loop.

filter_control.slider_restart_pause number

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

Max: 100

filter_control.sort boolean

Sorting.

Allowed values:

  • true (On)
  • false (Off)

controls_style.font_size number

Text size.

Max: 5

controls_style.font_weight string

Text weight.

Allowed values:

  • bold (Bold)
  • normal (Normal)

controls_style.height number

Height.

Max: 5

Background.

Text color.

Dropdown border styles.

Border style. Show border on all sides, or only at the bottom

Allowed values:

  • all (All sides)
  • bottom (Bottom)

Border width.

Max: 20

Color.

Transparency.

Max: 1

Radius.

Max: 100

button_style.background color

Background.

button_style.background_selected color

Selected.

button_style.background_hover color

Mouse over.

button_style.font_color color

Text color.

button_style.font_color_selected color

Selected.

button_style.font_color_hover color

Mouse over.

button_style.button_styles_advanced boolean

Button border styles.

button_style.border_width number

Border width.

Max: 20

button_style.border_color color

Color.

button_style.border_transparency number

Transparency.

Max: 1

button_style.border_radius number

Radius.

Max: 100

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.

filter_include_all boolean

Include "all". Include "All" in the filter dropdown

filter_all_label string

All label.

Layout

Layout

layout.body_font font

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

layout.font_color color

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

layout.background_color_enabled boolean

Color.

Allowed values:

  • true (On)
  • false (Off)

layout.background_image_enabled boolean

Image.

Allowed values:

  • true (On)
  • false (Off)

layout.background_color color

Background color.

layout.background_image_src url

Image URL.

layout.background_image_size string

Size.

Allowed values:

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

layout.background_image_position string

Position.

Allowed values:

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

layout.max_width_target string

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

Allowed values:

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

layout.max_width number

Maximum width. Leave blank to stretch to container width

Min: 50

layout.max_width_align string

Align.

Allowed values:

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

layout.layout_order string

Layout order.

Allowed values:

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

layout.space_between_sections string

Space between sections.

Allowed values:

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

layout.space_between_sections_custom number

Custom.

Max: 100

layout.margin_top number

Top.

layout.margin_right number

Right.

layout.margin_bottom number

Bottom.

layout.margin_left number

Left.

layout.border.enabled boolean

Show borders around visualisation.

layout.border.top.width number

Top.

layout.border.top.style string

Style.

Allowed values:

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

layout.border.top.color color

Color.

layout.border.right.width number

Right.

layout.border.right.style string

Style.

Allowed values:

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

layout.border.right.color color

Color.

layout.border.bottom.width number

Bottom.

layout.border.bottom.style string

Style.

Allowed values:

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

layout.border.bottom.color color

Color.

layout.border.left.width number

Left.

layout.border.left.style string

Style.

Allowed values:

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

layout.border.left.color color

Color.

layout.read_direction string

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

Allowed values:

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

layout.font_size_mobile_small number

layout.font_size_mobile_big number

layout.font_size_tablet number

layout.font_size_desktop number

layout.font_size_big_screen number

layout.breakpoint_mobile_small number

layout.breakpoint_mobile_big number

layout.breakpoint_tablet number

layout.breakpoint_desktop number

layout.breakpoint_big_screen number

layout.header_align string

Alignment.

Allowed values:

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

layout.title html

layout.title_styling boolean

Styling.

layout.title_font font

Title Font.

layout.title_size string

Size.

Allowed values:

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

layout.title_size_custom number

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

layout.title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.title_color color

Color.

layout.title_line_height number

Line height.

Max: 3

layout.title_space_above string

Space above.

Allowed values:

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

layout.title_space_above_custom number

Custom.

Max: 100

layout.subtitle html

layout.subtitle_styling boolean

Styling.

layout.subtitle_font font

Subtitle Font.

layout.subtitle_size string

Size.

Allowed values:

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

layout.subtitle_size_custom number

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

layout.subtitle_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.subtitle_color color

Color.

layout.subtitle_line_height number

Line height.

Max: 3

layout.subtitle_space_above string

Space above.

Allowed values:

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

layout.subtitle_space_above_custom number

Custom.

Max: 100

layout.header_text html

layout.header_text_styling boolean

Styling.

layout.header_text_size string

Size.

Allowed values:

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

layout.header_text_size_custom number

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

layout.header_text_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.header_text_color color

Color.

layout.header_text_line_height number

Line height.

Max: 3

layout.header_text_space_above string

Space above.

Allowed values:

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

layout.header_text_space_above_custom number

Custom.

Max: 100

layout.header_border string

Allowed values:

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

layout.header_border_width number

Width.

layout.header_border_color color

Color.

layout.header_border_style string

Style.

Allowed values:

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

layout.header_border_space number

Space. Space between border and header text

layout.header_logo_enabled boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

layout.header_logo_src url

Image.

layout.header_logo_alt string

Alt text.

Link.

layout.header_logo_height number

Height.

layout.header_logo_align string

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

Allowed values:

  • inside (Header)
  • outside (Main container)

layout.header_logo_position_inside string

Position.

Allowed values:

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

layout.header_logo_position_outside string

Position.

Allowed values:

  • left (Left)
  • right (Right)

layout.header_logo_margin_top number

Top.

layout.header_logo_margin_right number

Right.

layout.header_logo_margin_bottom number

Bottom.

layout.header_logo_margin_left number

Left.

layout.footer_align string

Alignment.

Allowed values:

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

layout.footer_text_size number

Size.

layout.footer_text_color color

Color.

layout.footer_styling boolean

Advanced footer styles.

layout.footer_font font

Font.

layout.footer_text_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.source_name string

Source name.

layout.source_url string

Source url.

layout.multiple_sources boolean

Multiple sources.

layout.source_name_2 string

Source name.

layout.source_url_2 string

Source url.

layout.source_name_3 string

Source name.

layout.source_url_3 string

Source url.

layout.source_label string

Source label.

layout.footer_note html

Note.

layout.footer_note_secondary html

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

layout.footer_logo_enabled boolean

Image.

Allowed values:

  • true (Enabled)
  • false (Disabled)

layout.footer_logo_src url

Image.

layout.footer_logo_src_light hidden

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

layout.footer_logo_alt string

Alt text.

Link.

layout.footer_logo_height number

Height.

layout.footer_logo_margin number

Margin.

layout.footer_logo_order string

Position.

Allowed values:

  • left (Left)
  • right (Right)

layout.footer_align_vertical string

V. align.

Allowed values:

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

layout.footer_border string

Allowed values:

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

layout.footer_border_width number

Width.

layout.footer_border_color color

Color.

layout.footer_border_style string

Style.

Allowed values:

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

layout.footer_border_space number

Space. Space between border and footer text

Accessibility

layout.screenreader_text_primary text

Screenreader description. A text alternative to the visual content that will only be visible to <a href="https://help.flourish.studio/article/230-how-to-add-a-screenreader-description">screenreaders</a>, e.g. “The line chart shows China consistently higher than the other countries since 1990”. <br><br>Do not replicate your title, since that will also be read by screenreaders.

layout.screenreader_label string

Screenreader label. A short text label given to the main Flourish embed wrapper to provide an accessible name that is only visible to <a href="https://help.flourish.studio/article/230-how-to-add-a-screenreader-description">screenreaders</a>. Added in the form of an "aria-label".

layout.screenreader_hide_primary boolean

Screenreader mode for main visual container. Whether the main visual container is visible to <a href="https://help.flourish.studio/article/230-how-to-add-a-screenreader-description">screenreaders</a>. (Text in the header and footer are always available to screenreaders.)

Allowed values:

  • true (Hidden)
  • false (Readable)