Growth comparison

A template for comparing exponential growth over time, developed for the 2020 COVID-19 crisis

Updated 3 months ago to v2.0.0-prerelease.7 by Flourish team

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/compare-growth

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:

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

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

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

{
    template: "@flourish/compare-growth",
    version: "2",
    bindings: {
        data: {
            regions: ["DataHeader1", "DataHeader2", ...],
            label: "DataHeader3",
            values: ["DataHeader4", "DataHeader5", ...],
            category: "DataHeader6",
            filter: "DataHeader7"
        }
    },
    data: {
        data: [
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            { "DataHeader1": ..., "DataHeader2": ..., ... },
            ...
        ]
    }
}

(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/compare-growth",
version: "2",
data: {
    data: [
        {
            regions: [...],
            values: [...]
        },
        ...
    ]
},
...
}

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

{
template: "@flourish/compare-growth",
version: "2",
data: {
    data: [
        {
            regions: [...],
            label: ...,
            values: [...],
            category: ...,
            filter: ...
        },
        ...
    ]
},
...
}

Meanings of the template data keys:

  • data.regions: A column of names
  • data.label: Set this column if you only want to show labels on particular lines. Leave blank to show all line labels.
  • data.values: A range of columns with dates as headers and numbers in the cells
  • data.category: A column of names
  • data.filter: E.g. a column containing "Deaths" versus "Cases"

Template settings

Options for opts.state.

Lines

region_count number

Show top….

Min: 1

region_sort string

…based on.

Allowed values:

  • growth (Doubling time)
  • max (Max value)

start_val number

Start from.

Min: 1

line_width number

Width. In rems – multiples of the base font size

dot_radius number

Dot radius. In rems – multiples of the base font size

Max: 0.2

line_curve string

Live curve.

Allowed values:

  • curve (Curve)
  • linear (Straight)
  • step (Step)

ref_lines text

Reference lines. Enter one per line, in the form shown (daily growth rate: label)

Colors

color.scale_type string

Scale type.

Allowed values:

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

color.categorical_type string

Allowed values:

  • palette (Palette)
  • generated (Generated)

color.categorical_palette colors

Palette.

color.categorical_extend boolean

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

color.categorical_seed_color color

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

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

color.categorical_color_space string

Allowed values:

  • hcl (HCL)
  • hsl (HSL)

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

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

color.sequential_custom_min color

Minimum color.

color.sequential_custom_max color

Maximum color.

color.sequential_color_space string

Allowed values:

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

color.sequential_reverse boolean

Reverse scale.

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

color.diverging_custom_min color

Minimum color.

color.diverging_custom_mid color

Midpoint color.

color.diverging_custom_max color

Maximum color.

color.diverging_color_space string

Allowed values:

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

color.diverging_reverse boolean

Reverse scale.

Legend

legend.show_legend boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

legend.text_color color

Color.

legend.text_size number

Size.

legend.title string

Title.

legend.title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Normal)

legend.swatch_width number

Width.

legend.swatch_height number

Height.

legend.swatch_radius number

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

legend.orientation string

Orientation.

Allowed values:

  • horizontal (Horizontal)
  • vertical (Vertical)

X axis

x.axis_position string

Position.

Allowed values:

  • bottom (Bottom)
  • float-below (Float ↓)
  • float-above (Float ↑)
  • top (Top)
  • off (Hidden)

x.y_axis_position string

Y value. Vertical position of the x axis on the y scale

x.numeric_scale_type string

Type.

Allowed values:

  • linear (Linear)
  • log (Log)

x.linear_min number

Min.

x.linear_max number

Max.

x.log_min number

Min.

x.log_max number

Max.

x.datetime_min string

Min (date).

x.datetime_max string

Max (date).

x.title_mode string

Type.

Allowed values:

  • auto (Auto)
  • custom (Custom)

x.title string

Text.

x.title_styling boolean

Styling.

x.title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

x.title_color color

Color.

x.title_size number

Size.

x.title_padding number

Padding.

x.tick_label_position string

Position.

Allowed values:

  • default (Default)
  • left (Left)
  • right (Right)

x.tick_label_styling boolean

Styling.

x.tick_label_size number

Size.

x.tick_label_color color

Color.

x.tick_padding number

Padding.

x.tick_label_angle string

Angle.

Allowed values:

  • 0 (0°)
  • 30 (30°)
  • 45 (45°)
  • 60 (60°)
  • 90 (90°)

x.tick_label_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

x.tick_label_space_mode string

Space mode.

Allowed values:

  • auto (Auto)
  • max (Max)
  • fixed (Fixed)

x.tick_label_space number

Space.

x.line_and_tick_color color

Line color.

x.line_and_tick_width number

Line width.

x.tick_length number

Tick length.

x.tick_side string

Tick side.

Allowed values:

  • out (Out)
  • in (In)

x.line_visible boolean

Axis line.

x.gridlines_visible boolean

Allowed values:

  • true (On)
  • false (Off)

x.gridlines_styling boolean

Styling.

x.gridline_color color

Color.

x.gridline_style string

Style.

Allowed values:

  • solid (Solid)
  • dash (Dashed)
  • dot (Dotted)
  • dot_dash (Dot-dashed)

x.gridline_width number

Width.

x.tick_number number

Number. Approximate number of ticks or gridlines. The actual number will depend on the range of values, chart size, etc.

Y axis

y.axis_visible boolean

Allowed values:

  • true (Axis visible)
  • false (Axis hidden)

y.numeric_scale_type string

Type.

Allowed values:

  • linear (Linear)
  • log (Log)

y.linear_min number

Min.

y.linear_max number

Max.

y.log_min number

Min.

y.log_max number

Max.

y.datetime_min string

Min (date).

y.datetime_max string

Max (date).

y.title_mode string

Type.

Allowed values:

  • auto (Auto)
  • custom (Custom)

y.title string

Text.

y.title_styling boolean

Styling.

y.title_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

y.title_color color

Color.

y.title_size number

Size.

y.title_padding number

Padding.

y.tick_label_position string

Position.

Allowed values:

  • default (Default)
  • above (Above)
  • below (Below)

y.tick_label_styling boolean

Styling.

y.tick_label_size number

Size.

y.tick_label_color color

Color.

y.tick_padding number

Padding.

y.tick_label_angle string

Angle.

Allowed values:

  • 0 (0°)
  • 30 (30°)
  • 45 (45°)
  • 60 (60°)
  • 90 (90°)

y.tick_label_weight string

Weight.

Allowed values:

  • bold (Bold)
  • normal (Regular)

y.tick_label_space_mode string

Space mode.

Allowed values:

  • auto (Auto)
  • max (Max)
  • fixed (Fixed)

y.tick_label_space number

Space.

y.line_and_tick_color color

Line color.

y.line_and_tick_width number

Line width.

y.tick_length number

Tick length.

y.tick_side string

Side.

Allowed values:

  • out (Out)
  • in (In)

y.line_visible boolean

Axis line.

y.gridlines_visible boolean

Allowed values:

  • true (On)
  • false (Off)

y.gridlines_styling boolean

Styling.

y.gridline_color color

Color.

y.gridline_style string

Style.

Allowed values:

  • solid (Solid)
  • dash (Dashed)
  • dot (Dotted)
  • dot_dash (Dot-dashed)

y.gridline_width number

Width.

y.tick_number number

Number. Approximate number of tick marks or gridlines. The actual number will depend on the range of values, chart size, etc.

Chart background

background.background_color_enabled boolean

Color.

Allowed values:

  • true (On)
  • false (Off)

background.background_image_enabled boolean

Image.

Allowed values:

  • true (On)
  • false (Off)

background.background_color color

Color.

background.background_image_src url

Image URL.

background.background_image_size string

Size.

Allowed values:

  • stretch (Stretch)
  • slice (Fill)
  • meet (Fit)

background.background_image_position string

Position.

Allowed values:

  • xMinYMin (Top left)
  • xMidYMin (Top center)
  • xMaxYMin (Top right)
  • xMaxYMid (Center left)
  • xMidYMid (Center)
  • xMaxYMid (Center right)
  • xMinYMax (Bottom left)
  • xMidYMax (Bottom center)
  • xMaxYMax (Bottom right)

Number and date formatting

datetime_input_format string

Format in data sheet. The date/time format in the data sheet. Leave as “Auto” for Flourish to make a best guess. If it 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:

  • auto (Auto)
  • %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/%m/%Y (28/01/1986)
  • %d-%b-%y (28-Jan-86)
  • %m/%Y (01/1986)
  • %m/%y (01/86)
  • %b %Y (Jan 1986)
  • %b %y (Jan 86)
  • %B %d (January 28)
  • %d %b (28 Jan)
  • %Y (1986)
  • '%y ('86)
  • %B (January)
  • %b (Jan)
  • %H:%M:%S (11:39:13)
  • %I:%M %p (11:39 AM)
  • %H:%M (11:39)

date_format string

Display format. The date/time format to show in the graphic. If it 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:

  • auto (Auto)
  • %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/%m/%Y (28/01/1986)
  • %d-%b-%y (28-Jan-86)
  • %m/%Y (01/1986)
  • %m/%y (01/86)
  • %b %Y (Jan 1986)
  • %b %y (Jan 86)
  • %B %d (January 28)
  • %d %b (28 Jan)
  • %Y (1986)
  • ’%y (’86)
  • %B (January)
  • %b (Jan)
  • %A (Tuesday)
  • %a (Tue)
  • %H:%M:%S (11:39:13)
  • %I:%M %p (11:39 AM)
  • %H:%M (11:39)

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.

Allowed values:

  • . (.)
  • , (,)

localization.output_separators string

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

Allowed values:

  • ,. (12,235.67)
  • ., (12.345,67)
  • . (12235.67)
  • , (12345,67)
  • . (12 235.67)
  • , (12 345,67)

formatter.prefix string

Prefix. Text to place in front of number

formatter.suffix string

Suffix. Text to place after number

formatter.n_dec number

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

Min: -10

Max: 10

formatter.strip_zeros boolean

Remove trailing zeros.

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

formatter.transform_labels boolean

Multiply/divide values.

formatter.transform string

Allowed values:

  • multiply (Multiply by)
  • divide (Divide by)
  • exponentiate (×10 to the power of)

formatter.multiply_divide_constant number

formatter.exponentiate_constant number

Controls

log_control_y_visible boolean

Show log control for Y axis.

log_control_y_width number

Width.

Min: 20

log_control_y_text_linear string

Linear text.

log_control_y_text_log string

Log text.

sort_control_visible boolean

Show sort control.

sort_control_width number

Width.

Min: 20

sort_control_text_growth string

Doubling time text.

sort_control_text_max string

Max value text.

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)