Point map

Map for displaying points, with optional time slider

Updated 5 years ago to v1.8.1 by Duncan Clark

How to use this template

A template for creating fast and beautiful maps showing points or events (points revealed over time). Useful for any data with locations in latitude and longitude format, but especially well suited for data with timestamps, such as website traffic or financial transactions. Events are shown as pulses on an interactive map, optionally scaled and coloured based on the data.

How to get started

At a minimum, you just need a spreadsheet of events with columns for latitude and longitude:

latitude longitude
-6.081689835 145.3919983
-5.207079887 145.7890015
-5.826789856 144.2960052

This will display events on the map, but the timeline will be hidden without a timestamp binding for your events. Be sure to set the date format in the "Localisation" section of the settings panel so that it matches your data!

timestamp
2019-04-17T06:53:30.000Z
2019-04-17T08:33:30.000Z
2019-04-17T09:28:30.000Z

The following bindings are also available:

  • Category: used to track separate categories of events in the event counter, and determines the colours of your events when using a categorical color scale.
  • End timestamp: the end time of the event in the same format as the main timestamp.
  • Value (Scale): numerical data, used to determine the scale at which to draw the event.
  • Value (Colour): numerical data, used to determine the colour of events when using a sequential or diverging colour scheme.

Customising the inset map

The inset map helps the viewer put the current map view in the context of a larger area: a country in the context of the world, say, or a city in the context of a country. By default, if enabled, the inset map shows a globe. But you can set the map to show any region you like by uploading one or more regions (in GeoJSON format) to the "Inset Map Regions" data sheet. Alternatively, if you just want one or more countries, you can copy the relevant row(s) from Regions datasheet of our Projection Map template.

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

FAQ

I don't have lat or lng locations, only place names You'll need to geocode your data. Various online tools that can help with this. Paying customers can contact the Flourish team for more help and advice.

How do I reset the initial zoom and centre of the map? The map automatically sets its initial zoom and centre to contain all your icons. If you want to override this you have two options. First: restrict the bounds of the map (under Base Map > Viewport). Second, create a story: hit the "Create a story" button and drag the map into whatever zoom/pan state you like, and it will be automatically saved. If you don't want the navigation bar at the top, choose "None" from the "Navigation" menu.

How can I tell a story with my map? If you'd like to give the audience a tour of the data and highlight different locations or regions one by one, create a Flourish story from your visualisation, then add multiple slides to highlight different places, as in the example below.

Credits

Created by the Flourish team, using open source tools including twemoji by Twitter under CC-BY 4.0, regl and mapbox-gl-js.

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: @duncan/time-map

version: 1

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: {
        events: [
            [ "EventsColumn1Value1", "EventsColumn2Value1",
            [ "EventsColumn1Value2", "EventsColumn2Value2",
            [ "EventsColumn1Value3", "EventsColumn2Value3",
            ...
        ],
        regions: [
            [ "RegionsColumn1Value1", "RegionsColumn2Value1",
            [ "RegionsColumn1Value2", "RegionsColumn2Value2",
            [ "RegionsColumn1Value3", "RegionsColumn2Value3",
            ...
        ]
    }
}

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: "@duncan/time-map",
    version: "1",
    bindings: {
        events: {
            lat: 0, // index of a column in your data
            lon: 1, // index of a column in your data
        },
        regions: {
            
        }
    },
    data: {
        events: [
            [ "EventsColumn1Value1", "EventsColumn2Value1",
            [ "EventsColumn1Value2", "EventsColumn2Value2",
            [ "EventsColumn1Value3", "EventsColumn2Value3",
            ...
        ],
        regions: [
            [ "RegionsColumn1Value1", "RegionsColumn2Value1",
            [ "RegionsColumn1Value2", "RegionsColumn2Value2",
            [ "RegionsColumn1Value3", "RegionsColumn2Value3",
            ...
        ]
    }
}

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

{
    template: "@duncan/time-map",
    version: "1",
    bindings: {
        events: {
            lat: 0, // index of a column in your data
            lon: 1, // index of a column in your data
            start_timestamp: 2, // index of a column in your data
            end_timestamp: 3, // index of a column in your data
            metadata: [4, 5, ...], // index(es) of column(s) in your data
            category: 6, // index of a column in your data
            scale: 7, // index of a column in your data
            color: 8, // index of a column in your data
            group: 9, // index of a column in your data
        },
        regions: {
            geojson: 0, // index of a column in your data
        }
    },
    data: {
        events: [
            [ "EventsColumn1Value1", "EventsColumn2Value1",
            [ "EventsColumn1Value2", "EventsColumn2Value2",
            [ "EventsColumn1Value3", "EventsColumn2Value3",
            ...
        ],
        regions: [
            [ "RegionsColumn1Value1", "RegionsColumn2Value1",
            [ "RegionsColumn1Value2", "RegionsColumn2Value2",
            [ "RegionsColumn1Value3", "RegionsColumn2Value3",
            ...
        ]
    }
}

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:

{
        events: [
            { "EventsHeader1": ..., "EventsHeader2": ..., ... },
            { "EventsHeader1": ..., "EventsHeader2": ..., ... },
            { "EventsHeader1": ..., "EventsHeader2": ..., ... },
            ...
        ],
        regions: [
            { "RegionsHeader1": ..., "RegionsHeader2": ..., ... },
            { "RegionsHeader1": ..., "RegionsHeader2": ..., ... },
            { "RegionsHeader1": ..., "RegionsHeader2": ..., ... },
            ...
        ]
    }

... 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: "@duncan/time-map",
    version: "1",
    bindings: {
        events: {
            lat: "EventsHeader1",
            lon: "EventsHeader2",
        },
        regions: {
            
        }
    },
    data: {
        events: [
            { "EventsHeader1": ..., "EventsHeader2": ..., ... },
            { "EventsHeader1": ..., "EventsHeader2": ..., ... },
            { "EventsHeader1": ..., "EventsHeader2": ..., ... },
            ...
        ],
        regions: [
            { "RegionsHeader1": ..., "RegionsHeader2": ..., ... },
            { "RegionsHeader1": ..., "RegionsHeader2": ..., ... },
            { "RegionsHeader1": ..., "RegionsHeader2": ..., ... },
            ...
        ]
    }
}

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

{
    template: "@duncan/time-map",
    version: "1",
    bindings: {
        events: {
            lat: "EventsHeader1",
            lon: "EventsHeader2",
            start_timestamp: "EventsHeader3",
            end_timestamp: "EventsHeader4",
            metadata: ["EventsHeader5", "EventsHeader6", ...],
            category: "EventsHeader7",
            scale: "EventsHeader8",
            color: "EventsHeader9",
            group: "EventsHeader10",
        },
        regions: {
            geojson: "RegionsHeader1",
        }
    },
    data: {
        events: [
            { "EventsHeader1": ..., "EventsHeader2": ..., ... },
            { "EventsHeader1": ..., "EventsHeader2": ..., ... },
            { "EventsHeader1": ..., "EventsHeader2": ..., ... },
            ...
        ],
        regions: [
            { "RegionsHeader1": ..., "RegionsHeader2": ..., ... },
            { "RegionsHeader1": ..., "RegionsHeader2": ..., ... },
            { "RegionsHeader1": ..., "RegionsHeader2": ..., ... },
            ...
        ]
    }
}

(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: "@duncan/time-map",
    version: "1",
    data: {
    events: [
        {
            lat: ...,
            lon: ...,
            metadata: [...]
        },
        ...
    ]
},
    ...
}

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

{
    template: "@duncan/time-map",
    version: "1",
    data: {
    events: [
        {
            lat: ...,
            lon: ...,
            start_timestamp: ...,
            end_timestamp: ...,
            metadata: [...],
            category: ...,
            scale: ...,
            color: ...,
            group: ...
        },
        ...
    ],
    regions: [
        {
            geojson: ...
        },
        ...
    ]
},
    ...
}

Meanings of the template data keys:

  • events.lat: lat
  • events.lon: lon
  • events.start_timestamp: Determines when the circles appear. If left blank all the events will appear at once. If selected, creates a time slider and shows dots over time. The date format must be specified in the settings panel.
  • events.end_timestamp: Determines when the circles disappear. If not specified the circle remains for the default duration specified in the settings panel.
  • events.metadata: One or more columns to show in the popups
  • events.category: Used to categorise events, and to determine their colour when using a categorical colour palette.
  • events.scale: Determines the size of the circles.
  • events.color: Determines the colour of the circles when using sequential or divering colour palettes.
  • events.group: group
  • regions.geojson: geojson

Template settings

Options for opts.state.

Events

event_style string

Appearance.

Allowed values:

  • pulse (Pulses)
  • circle (Circles)

date_format string

Date/time format in data. The date/time format in your data sheet. 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:

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

count_by string

Count by. Determines how much your event contributes to the values in the counter and timeline graph, if applicable. Choosing 'count' will use the total number of events, whereas choosing 'scale' or 'color' will accumulate the scale or color values of each event.

Allowed values:

  • count (Count)
  • scale (Scale)
  • color (Colour)

empty_category_include boolean

Fallback category. Creates a new "other" category for uncategorised events

Allowed values:

  • true (Enable)
  • false (Disable)

empty_category_label string

Label.

display_below_labels boolean

Draw map labels in front of events.

default_size number

Default size.

min_size number

Min size.

max_size number

Max size.

scale_with_zoom boolean

Scale with zoom.

Allowed values:

  • true (On)
  • false (Off)

min_scale_zoom number

Min zoom.

Max: 24

max_scale_zoom number

Max zoom.

Max: 24

default_color color

Default color.

event_opacity number

Opacity.

Max: 100

default_color_is_zero boolean

Fallback to zero. When enabled, invalid or missing colour values are treated as zero. When disabled, these values will fall back to the default colour value intead.

blend_mode string

Blend mode. Determines how event colors mix with the map or events beneath them. Additive adds the colours together making events appear to glow, and works best on darker maps. Subtractive subtracts colours from their background like ink on paper, and works best on lighter maps.

Allowed values:

  • normal (Normal)
  • additive (Additive)
  • subtractive (Subtractive)

color_palette.scale_type string

Scale type.

Allowed values:

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

color_palette.categorical_type string

Allowed values:

  • palette (Palette)
  • generated (Generated)

color_palette.categorical_palette colors

Palette.

color_palette.categorical_extend boolean

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

color_palette.categorical_seed_color color

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

color_palette.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_palette.categorical_color_space string

Allowed values:

  • hcl (HCL)
  • hsl (HSL)

color_palette.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_palette.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_palette.sequential_custom_min color

Minimum color.

color_palette.sequential_custom_max color

Maximum color.

color_palette.sequential_color_space string

Allowed values:

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

color_palette.sequential_reverse boolean

Reverse scale.

color_palette.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_palette.diverging_custom_min color

Minimum color.

color_palette.diverging_custom_mid color

Midpoint color.

color_palette.diverging_custom_max color

Maximum color.

color_palette.diverging_color_space string

Allowed values:

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

color_palette.diverging_reverse boolean

Reverse scale.

Timeline

timeline.enabled boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

timeline.margin number

Margin.

timeline.color_axes color

Axes color.

timeline.date_format_display string

X axis date format.

Allowed values:

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

timeline.graph boolean

Visibility.

Allowed values:

  • true (Show)
  • false (Hide)

timeline.color_background color

Background.

timeline.curve boolean

Curved lines.

Counter

counter_enabled boolean

Enable counter.

Allowed values:

  • true (Enabled)
  • false (Disabled)

counter_position string

Position.

Allowed values:

  • top (Top)
  • bottom (Bottom)

counter_layout string

Layout.

Allowed values:

  • vertical (Vertical)
  • horizontal (Horizontal)
  • legend (Legend)

counter_hide_values boolean

Hide counter values.

counter_colorize boolean

Colour values based on category.

counter_color_text color

Colour.

counter_color_shadow color

Shadow.

counter_alpha_shadow number

Shadow opacity.

Max: 100

counter_color_text_legend color

Text colour.

counter_legend_background color

Background color.

counter_label_rate string

"Rate" button.

counter_label_total string

"Total" button.

Animation

timeline.duration number

Timeline duration (s). Total duration of the timeline during normal playback.

timeline.duration_pulse number

Pulse duration (s).

timeline.duration_time number

Time transition duration (s). Duration of transitions between different points in time on the timeline.

Base map

map.style_enabled boolean

Allowed values:

  • true (Enable)
  • false (Disable)

map.style_base string

Map style.

Allowed values:

  • positron (Positron)
  • osm-bright (OSM Bright)
  • klokantech-basic (Klokantech Basic)
  • klokantech-3d (Klokantech 3D)
  • klokantech-terrain (Klokantech Terrain)
  • fiord-color (Fiord)
  • toner (Toner)
  • dark-matter (Dark Matter)
  • custom-monochrome (Custom: Monochrome)

map.style_monochrome_color color

Map base color.

map.style_show_borders boolean

Display borders.

map.style_show_roads boolean

Display transport.

map.style_show_labels boolean

Display labels.

map.style_show_landuse boolean

Display land use.

map.style_show_water boolean

Display water.

map.map_language_auto boolean

Detect language. Automatically changes the language used on the base map to match the viewer's language settings.

map.map_language_alts boolean

Display alternatives. Whether or not to display latin alternatives for non-latin languages (or vice versa)

map.map_language string

Language.

Allowed values:

  • native (Local language)
  • ar (Arabic)
  • az (Azerbaijani)
  • be (Belarusian)
  • bg (Bulgarian)
  • br (Breton)
  • bs (Bosnian)
  • ca (Catalan)
  • cs (Czech)
  • cy (Welsh)
  • da (Danish)
  • de (German)
  • el (Greek)
  • en (English)
  • eo (Esperanto)
  • es (Spanish)
  • et (Estonian)
  • fi (Finnish)
  • fr (French)
  • fy (Western Frisian)
  • ga (Irish)
  • gd (Scottish Gaelic)
  • he (Hebrew)
  • hr (Croatian)
  • hu (Hungarian)
  • hy (Armenian)
  • is (Icelandic)
  • it (Italian)
  • ja (Japanese)
  • ja_kana (Japanese Kana form)
  • ja_rm (Romanization of Japanese)
  • ka (Georgian)
  • kk (Kazakh)
  • kn (Kannada)
  • ko (Korean)
  • ko_rm (Romanization of Korean)
  • la (Latin)
  • lb (Luxembourgish)
  • lt (Lithuanian)
  • lv (Latvian)
  • mk (Macedonian)
  • mt (Maltese)
  • ml (Malayalam)
  • nl (Dutch)
  • no (Norwegian)
  • pl (Polish)
  • pt (Portuguese)
  • rm (Romansh)
  • ro (Romania)
  • ru (Russian)
  • sk (Slovak)
  • sl (Slovene)
  • sq (Albanian)
  • sr (Serbian (Cyrillic))
  • sr-Latn (Serbian (Latin))
  • sv (Swedish)
  • th (Thai)
  • tr (Turkish)
  • uk (Ukrainian)
  • zh (Chinese)

map.map_zoom_min number

Min zoom.

Max: 22

map.map_zoom_max number

Max zoom.

Max: 22

map.map_bound_position boolean

Limit viewport bounds.

map.map_lat_min number

Min latitude.

Min: -90

Max: 90

map.map_lat_max number

Max latitude.

Min: -90

Max: 90

map.map_lng_min number

Min longitude.

Min: -180

Max: 180

map.map_lng_max number

Max longitude.

Min: -180

Max: 180

map.map_initial_type string

Initial viewport. By default, the initial viewport of the map is automatically set to include every visible object. The "centroid" option allows you to select a custom latitude, longitude and zoom. The "bounds" option lets you specify a custom bounding box for the viewport to enclose.

Allowed values:

  • auto (Auto)
  • centroid_zoom (Centroid)
  • bounding_box (Bounds)

map.map_initial_pitch number

Pitch.

Max: 60

map.map_initial_bearing number

Bearing.

Min: -180

Max: 180

map.map_initial_lat number

Latitude.

Min: -90

Max: 90

map.map_initial_lng number

Longitude.

Min: -180

Max: 180

map.map_initial_zoom number

Zoom.

Max: 22

map.map_initial_bounds_lat_min number

Min latitude.

Min: -90

Max: 90

map.map_initial_bounds_lng_min number

Min longitude.

Min: -180

Max: 180

map.map_initial_bounds_lat_max number

Max latitude.

Min: -90

Max: 90

map.map_initial_bounds_lng_max number

Max longitude.

Min: -180

Max: 180

map.map_interactive boolean

Allow user interaction.

map.map_hijack_scroll boolean

Require cmd/ctrl to zoom when scrolling.

map.controls_geolocator_enabled boolean

Use geolocator control.

map.controls_geolocator_alignment string

Geolocator control position.

Allowed values:

  • top-left (Top left)
  • top-right (Top right)
  • bottom-left (Bottom left)
  • bottom-right (Bottom right)

map.controls_fullscreen_enabled boolean

Use fullscreen control.

map.controls_fullscreen_alignment string

Fullscreen control position.

Allowed values:

  • top-left (Top left)
  • top-right (Top right)
  • bottom-left (Bottom left)
  • bottom-right (Bottom right)

map.animation_enabled boolean

Enable animation.

map.animation_speed number

Speed.

Min: 0.01

Max: 4

Inset map

minimap.minimap_display boolean

Display map.

minimap.minimap_rotate boolean

Rotate with camera.

minimap.minimap_custom_colors boolean

Customise colours.

minimap.minimap_fill color

Region fill color.

minimap.minimap_ocean_color color

Ocean color.

minimap.minimap_stroke color

Region stroke color.

minimap.minimap_outline color

Outline color.

minimap.minimap_show_bounds boolean

Display viewport bounds.

minimap.minimap_bounds_color color

Region bounds color.

minimap.minimap_bounds_opacity number

Region bounds opacity.

Max: 1

minimap.minimap_size_type string

Size units.

Allowed values:

  • px (px)
  • vh (vh)
  • vw (vw)
  • vmin (vmin)
  • vmax (vmax)

minimap.minimap_size_desktop_pixels number

Pixels (desktop).

Min: 1

minimap.minimap_size_mobile_pixels number

Pixels (mobile).

Min: 1

minimap.minimap_size_desktop_viewport number

Screen % (desktop).

Min: 1

Max: 100

minimap.minimap_size_mobile_viewport number

Screen % (mobile).

Min: 1

Max: 100

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

Localization

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

Layout

layout.body_font font

Font.

layout.max_width number

Maximum width. Leave blank to stretch to container width

Min: 50

layout.margin number

Margin.

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

Change title styles.

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

layout.subtitle_styling boolean

Change subtitle styles.

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

Change text styles.

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

Source name.

layout.source_url string

Source url.

layout.multiple_sources boolean

Multiple sources.

layout.source_name_2 string

Source name.

layout.source_url_2 string

Source url.

layout.source_name_3 string

Source name.

layout.source_url_3 string

Source url.

layout.source_label string

Source label.

layout.note string

Note.

layout.size number

Size.

layout.color color

Color.

layout.footer_align string

Alignment.

Allowed values:

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

layout.logo_url url

Image.

Link.

layout.logo_height number

Height.

layout.logo_margin number

Margin.

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