Sports

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

Updated 2 months ago to v2.0.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: 2

Template data

There are two different formats in which you can supply data to this template. Which one will be more convenient for you likely depends on the source of your data, as described below.

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:

    {
        players: [
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            ...
        ]
    }

... but with the keys being the column headers from your source data instead. To tell the API how these 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: "2",
    bindings: {
        players: {
            
        }
    },
    data: {
        players: [
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@flourish/sports",
    version: "2",
    bindings: {
        players: {
            info: ["PlayersHeader1", "PlayersHeader2", ...],
            team: "PlayersHeader3",
            size: "PlayersHeader4",
            category: "PlayersHeader5",
            photo: "PlayersHeader6",
            position_x: "PlayersHeader7",
            position_y: "PlayersHeader8",
            filter: "PlayersHeader9",
            metadata: ["PlayersHeader10", "PlayersHeader11", ...]
        }
    },
    data: {
        players: [
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            { "PlayersHeader1": ..., "PlayersHeader2": ..., ... },
            ...
        ]
    }
}

(As before, the keys containing "Header" would be replaced by column names from your data source.)

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: "2",
data: {
    players: [
        {
            info: [...],
            metadata: [...]
        },
        ...
    ]
},
...
}

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

{
template: "@flourish/sports",
version: "2",
data: {
    players: [
        {
            info: [...],
            team: ...,
            size: ...,
            category: ...,
            photo: ...,
            position_x: ...,
            position_y: ...,
            filter: ...,
            metadata: [...]
        },
        ...
    ]
},
...
}

Meanings of the template data keys:

  • players.info: eg. the player's name
  • players.team: Used to set fill color for each dot
  • players.size: Use this column to adjust the size of the circle
  • players.category: Used to set stroke color for each dot
  • players.photo: Point to column with image urls
  • players.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"
  • players.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"
  • players.filter: Setting a column here will add a control to the visualisation to filter the players. You could use this for example on a time or country column.
  • players.metadata: metadata

Template settings

Options for opts.state.

Players

positions_type string

Players position. Position players based on a specific formation, or use x and y coordinates for players if you have the data

Allowed values:

  • formation (Default formations)
  • data (Positions from data)

positions_reverse boolean

Start formation.

Allowed values:

  • false (Top)
  • true (Bottom)

positions_scale_custom boolean

Position scale.

Allowed values:

  • false (Auto)
  • true (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)

formation_custom code

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

Pitch

pitch.background color

Background.

aspect_ratio number

Aspect ratio.

Min: 0.1

pitch.offset number

Offset.

Max: 5

pitch.margin_top number

Top margin.

pitch.margin_bottom number

Bottom margin.

pitch.type string

Type.

Allowed values:

  • football (Football pitch)
  • football_half (Football pitch (half))
  • basketball (Basketball)
  • other (Other)

pitch.line_color color

Color.

pitch.line_width number

Width.

pitch.type_custom string

Allowed values:

  • upload (Upload file)
  • svg (Write custom svg)

pitch.type_upload url

Upload.

pitch.type_svg text

SVG.

pitch.rotation_x number

X Rotation.

pitch.rotation_z number

Z Rotation.

pitch.shadow number

Shadow.

Dots

dot_size number

Size. As percentage of the pitch width

colors_team_single color

Color.

dot_opacity number

Opacity.

Max: 1

label_size number

Label size.

label_color color

Label.

colors_team.scale_type string

Scale type.

Allowed values:

  • categorical (Categorical)
  • sequential (Sequential)
  • diverging (Diverging)

colors_team.categorical_type string

Allowed values:

  • palette (Palette)
  • generated (Generated)

colors_team.categorical_palette colors

Palette.

colors_team.categorical_extend boolean

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

colors_team.categorical_seed_color color

Seed color. Initial color in generated sequence (avoid shades of grey).

colors_team.categorical_rotation_angle number

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

Max: 360

colors_team.categorical_color_space string

Allowed values:

  • hcl (HCL)
  • hsl (HSL)

colors_team.categorical_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:<br /><hr />Party 1: red<br />Party 2: #4455AA<br />Party 3: rgb(30,168,26)

colors_team.sequential_palette string

Palette.

Allowed values:

  • Oranges
  • Reds
  • Blues
  • Greens
  • Greys
  • Purples
  • Viridis
  • Inferno
  • Magma
  • Plasma
  • Warm
  • 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_team.sequential_custom_min color

Minimum color.

colors_team.sequential_custom_max color

Maximum color.

colors_team.sequential_color_space string

Allowed values:

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

colors_team.sequential_reverse boolean

Reverse scale.

colors_team.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
  • Custom

colors_team.diverging_custom_min color

Minimum color.

colors_team.diverging_custom_mid color

Midpoint color.

colors_team.diverging_custom_max color

Maximum color.

colors_team.diverging_color_space string

Allowed values:

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

colors_team.diverging_reverse boolean

Reverse scale.

dot_border number

Width.

colors_category_single color

Color.

colors_category.scale_type string

Scale type.

Allowed values:

  • categorical (Categorical)
  • sequential (Sequential)
  • diverging (Diverging)

colors_category.categorical_type string

Allowed values:

  • palette (Palette)
  • generated (Generated)

colors_category.categorical_palette colors

Palette.

colors_category.categorical_extend boolean

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

colors_category.categorical_seed_color color

Seed color. Initial color in generated sequence (avoid shades of grey).

colors_category.categorical_rotation_angle number

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

Max: 360

colors_category.categorical_color_space string

Allowed values:

  • hcl (HCL)
  • hsl (HSL)

colors_category.categorical_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:<br /><hr />Party 1: red<br />Party 2: #4455AA<br />Party 3: rgb(30,168,26)

colors_category.sequential_palette string

Palette.

Allowed values:

  • Oranges
  • Reds
  • Blues
  • Greens
  • Greys
  • Purples
  • Viridis
  • Inferno
  • Magma
  • Plasma
  • Warm
  • 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_category.sequential_custom_min color

Minimum color.

colors_category.sequential_custom_max color

Maximum color.

colors_category.sequential_color_space string

Allowed values:

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

colors_category.sequential_reverse boolean

Reverse scale.

colors_category.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
  • Custom

colors_category.diverging_custom_min color

Minimum color.

colors_category.diverging_custom_mid color

Midpoint color.

colors_category.diverging_custom_max color

Maximum color.

colors_category.diverging_color_space string

Allowed values:

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

colors_category.diverging_reverse boolean

Reverse scale.

image_styles_enabled boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

image_contrast number

Contrast.

image_brightness number

Brightness.

image_saturation number

Saturation.

image_blend_mode string

Blend mode.

Allowed values:

  • lighten (Lighten)
  • darken (Darken)
  • multiply (Multiply)

animation_target string

Animate.

Allowed values:

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

animation_duration number

Duration.

Popups

popup.show_popups boolean

Popups.

Allowed values:

  • true (Enabled)
  • false (Disabled)

popup.is_custom boolean

Popup contents.

Allowed values:

  • false (Auto)
  • true (Custom content)

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.

Allowed values:

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

popup.font_size number

Font size.

Min: 1

popup.fill_color color

Fill colour.

popup.opacity number

Fill opacity.

Max: 1

popup.padding number

Padding.

popup.border_radius number

Radius. Corner radius of popup

Filter controls

filter_control.type string

Data type.

Allowed values:

  • categorical (Categories)
  • temporal (Dates/times)
  • numeric (Numbers)

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

Predefined values:

  • %Y-%m-%dT%H:%M:%S.%LZ (1986-01-28T11:39:13.000Z)
  • %Y-%m-%d (1986-01-28)
  • %m/%d/%Y (01/28/1986)
  • %d-%b-%y (28-Jan-86)
  • %m/%Y (01/1986)
  • %b %Y (Jan 1986)
  • %B %d (January 28)
  • %d %b (28 Jan)
  • %Y (1986)
  • %B (January)
  • %b (Jan)
  • %A (Tuesday)
  • %a (Tue)
  • %X (11:39:13)
  • %H:%M %p (11:39 AM)
  • %H:%M (11:39)

filter_control.sort boolean

Sort menu.

filter_control.control string

Control.

Allowed values:

  • auto (Auto)
  • dropdown (Dropdown menu)
  • slider (Slider)
  • grouped-buttons (Button group)
  • floating-buttons (Buttons)

filter_control.width number

Menu width.

Min: 150

filter_control.play_button boolean

Include play button.

filter_control.step_time number

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

filter_control.loop boolean

Loop on play.

filter_control.restart_pause number

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

filter_control.dropdown_icon_color color

Icon color.

filter_control.slider_handle_color color

Handle and button color.

filter_control.slider_track_color color

Track and label color.

Layout

Layout

layout.body_font font

Font.

layout.max_width number

Maximum width. Leave blank to stretch to container width

Min: 50

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

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

Layout order.

Allowed values:

  • stack-default (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAANhJREFUSA3tVNEOwiAM7Iy/p2/wkTz6g5gjOVZZEepcjMmWLBTau95ugIh6lpzzLcb4wNpFJaRk9MIahxAyXmD7mC7BC2RlFbliQjFMpJTujOdGs/ECwRoP3rlKoEzNJlz3+CwutK0NLRVt2QhjggA9n2IGEKANMxmt0VVsEfxgzfX7zL3ZiqbXLjcKc8vEORk5/75mMB/7u11uuIpdbtDCc5R3l/s+e+pmHt1foza7Nv6IXOeHiqGk9zWtSk1cN2cPrItnYjZzHZEZYtacxHTiuANSO/xN8AS4uW8Rw1Gu2AAAAABJRU5ErkJggg==)
  • stack-2 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAAMpJREFUSA3tVMsKwyAQNKW/l970Iz32Bw0jjKTrSLUY0oOBsO5rnOwYnTs9W0ppDyG8EcsOkw8uauu9T3jR2+75yJxBnnC4JxMxxlezg0V9VsJsIGz75TfKdlkpg3aPcT8TsPNRMJjZEIf5xaAAahUyE+RtfcZvtFLoFh95aFXxH4hCWpUoTCg7fxqUfB4yEcl/CJlNy5qbfuZA8m8CwJ77q2djSj50lnuAWbOAOQlXxCuRHxcUje2XzfgrYzBpHUXLkmxh181SpnEAB4Vg0DSGhHsAAAAASUVORK5CYII=)
  • stack-3 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAANFJREFUSA3tVEEOwyAMo9O+193gkRz3QSZHMmNRUkGp1guVqkCIHZMAITTfVkrZU0pv+B7NQpCV1vEdxxgLfmB9jEvwBBNzkjXn/HIRDOqzJs0GwS1eEmonAn52RITJaUYScd5KLl0fTQf58HVpIFlXMDPNBVMf2TDXPq7dZM2eelrMQ6uDucG50mlWzG/ooCWDvqENXldn1pcyhpgJWjYcPe5z5ZFrAgoe2LN0f2v1ZYq5UyofuiME99hFXKtUm1c9aoBmeEeRjVIQma6XpVblAwnpZjN/VjqsAAAAAElFTkSuQmCC)
  • stack-4 (data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAdCAYAAAHZdKxuAAAAAXNSR0IArs4c6QAAANtJREFUSA3tVNEOwjAI3Iy/p2/tR/bRH6zekmuA1glO45bYZAHKcdDCOk1izbXWC+0zlJzzDVJ5sNGW9qSUKj4QKY8yWvBDUWnoKKVcTzS2yWHiIfeMwm2yIbLbRL3DRJYubi+0bAPCkcvapO3AdFgZvuDuyJZR2i4wSpBBP9ZD7RsOLQ9gD/Y5ZmaA3EEHWY6r3SEwrzDEHLpnlvOXa4/7xttZfhNwyPdKcqLPaz6JlXpr9bNgCfbobw2ch5iY0CQzyCOPR9ya5zleBPNy3LxknAbiv1YxExxH3gEqBW7I4zw3PQAAAABJRU5ErkJggg==)

layout.space_between_sections string

Space between sections.

Allowed values:

  • 0 (▁)
  • 0.5 (▃)
  • 1 (▄)
  • 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.header_align string

Alignment.

Allowed values:

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

layout.title string

layout.title_styling boolean

Styling.

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

layout.subtitle_styling boolean

Styling.

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

layout.text_styling boolean

Styling.

layout.text_size string

Size.

Allowed values:

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

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.

Allowed values:

  • bold (Bold)
  • normal (Regular)

layout.text_color color

Color.

layout.text_line_height number

Line height.

Max: 3

layout.text_space_above string

Space above.

Allowed values:

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

layout.text_space_above_custom number

Custom.

Max: 100

layout.header_border string

Allowed values:

  • top (Top)
  • bottom (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_logo_enabled boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

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

Allowed values:

  • outside (Outside)
  • inside (Inside)

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.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_text_size number

Size.

layout.footer_text_color color

Color.

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_logo_enabled boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

layout.footer_logo_src url

Image.

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