3D map

Map for displaying points, with optional time slider

Updated a month ago to v7.1.3 by Flourish team

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 points with columns for latitude and longitude:

latitude longitude
-6.081689835 145.3919983
-5.207079887 145.7890015
-5.826789856 144.2960052

This will display points on the map, but the timeline will be hidden without a Start time binding for your points. Be sure to set the date format in the "Points" section of the settings panel so that it matches your data. Keep in mind you can also overwrite the date format by using d3-time-format syntax.

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 points in the counter, and determines the colours of your points when using a categorical color scale.
  • End time: 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 point.
  • Value (Colour): numerical data, used to determine the colour of points 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, for example latlong.net, can help with this.

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 points. 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 visualization, then add multiple slides to highlight different places.

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

version: 7

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:

    {
        regions_map: [
            { "Regions_mapHeader1": ..., "Regions_mapHeader2": ..., ... },
            { "Regions_mapHeader1": ..., "Regions_mapHeader2": ..., ... },
            { "Regions_mapHeader1": ..., "Regions_mapHeader2": ..., ... },
            ...
        ],
        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. 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/time-map",
    version: "7",
    bindings: {
        regions_map: {
            
        },
        events: {
            lat: "EventsHeader1",
            lon: "EventsHeader2"
        },
        regions: {
            
        }
    },
    data: {
        regions_map: [
            { "Regions_mapHeader1": ..., "Regions_mapHeader2": ..., ... },
            { "Regions_mapHeader1": ..., "Regions_mapHeader2": ..., ... },
            { "Regions_mapHeader1": ..., "Regions_mapHeader2": ..., ... },
            ...
        ],
        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: "@flourish/time-map",
    version: "7",
    bindings: {
        regions_map: {
            geojson: "Regions_mapHeader1",
            name: "Regions_mapHeader2",
            value: ["Regions_mapHeader3", "Regions_mapHeader4", ...],
            height: "Regions_mapHeader5",
            category: "Regions_mapHeader6",
            metadata: ["Regions_mapHeader7", "Regions_mapHeader8", ...]
        },
        events: {
            lat: "EventsHeader1",
            lon: "EventsHeader2",
            scale: "EventsHeader3",
            color: "EventsHeader4",
            start_timestamp: "EventsHeader5",
            end_timestamp: "EventsHeader6",
            group: "EventsHeader7",
            category: "EventsHeader8",
            count: "EventsHeader9",
            metadata: ["EventsHeader10", "EventsHeader11", ...]
        },
        regions: {
            geojson: "RegionsHeader1"
        }
    },
    data: {
        regions_map: [
            { "Regions_mapHeader1": ..., "Regions_mapHeader2": ..., ... },
            { "Regions_mapHeader1": ..., "Regions_mapHeader2": ..., ... },
            { "Regions_mapHeader1": ..., "Regions_mapHeader2": ..., ... },
            ...
        ],
        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.)

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

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

{
template: "@flourish/time-map",
version: "7",
data: {
    regions_map: [
        {
            geojson: ...,
            name: ...,
            value: [...],
            height: ...,
            category: ...,
            metadata: [...]
        },
        ...
    ],
    events: [
        {
            lat: ...,
            lon: ...,
            scale: ...,
            color: ...,
            start_timestamp: ...,
            end_timestamp: ...,
            group: ...,
            category: ...,
            count: ...,
            metadata: [...]
        },
        ...
    ],
    regions: [
        {
            geojson: ...
        },
        ...
    ]
},
...
}

Meanings of the template data keys:

  • regions_map.geojson: geojson
  • regions_map.name: name
  • regions_map.value: value
  • regions_map.height: height
  • regions_map.category: category
  • regions_map.metadata: metadata
  • events.lat: lat
  • events.lon: lon
  • events.scale: Determines the size of the circles.
  • events.color: Determines the colour of the circles when using sequential or divering colour palettes.
  • events.start_timestamp: Determines when the circles appear. If left blank all the points will appear at once. If selected, creates a timeline 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.group: Use this to animate points between different values at different times in the timeline. Rows with the same ID will animate from one set of values to another based on their start time.
  • events.category: Used to categorise points, and to determine their colour when using a categorical colour palette.
  • events.count: Determines how much each row is counted for by the counter. If not bound to a column, each row's count is treated as one.
  • events.metadata: One or more columns to show in the popups
  • regions.geojson: geojson

Template settings

Options for opts.state.

Base map

map.map_type string

Map type.

Allowed values:

  • tiles (Background Map)
  • projection (Projection)

map.style_enabled boolean

Background map.

Allowed values:

  • true (Enabled)
  • false (Disabled)

map.style_base string

Map style.

Allowed values:

  • flourish-light (Flourish Light)
  • flourish-dark (Flourish Dark)
  • flourish-2-tone (Flourish 2-Tone)
  • positron (Positron)
  • osm-bright (OSM Bright)
  • klokantech-basic (Klokantech Basic)
  • klokantech-3d (Klokantech 3D)
  • fiord-color (Fiord)
  • toner (Toner)
  • dark-matter (Dark Matter)
  • custom-monochrome (Custom: Monochrome)
  • custom-palette (Custom: Palette)
  • custom-json (Custom: JSON)

map.style_custom_enabled boolean

Customize layers.

map.style_monochrome_color color

Map base color.

map.style_custom_toner.primary color

Primary.

map.style_custom_toner.secondary color

Secondary.

map.style_custom_json code

Custom JSON style data. Include your own custom mapbox-gl-js style for full control over your maps' appearance. Note that we use tiles that match the OpenMapTiles schema, so it's recommended that you use <a href="https://maputnik.github.io/">Maputnik</a> to create your styles.

map.style_custom_palette.ground color

Ground.

map.style_custom_palette.ocean color

Ocean.

map.style_custom_palette.grass color

Nature.

map.style_custom_palette.buildings color

Buildings.

map.style_custom_palette.road color

Roads.

map.style_custom_palette.road_outline color

Road outlines.

map.style_custom_palette.text_fill color

Text.

map.style_custom_palette.text_stroke color

Text outlines.

map.style_custom_palette.border color

State/national borders.

map.style_font_face string

Font override. Replace the map's default fonts with a font of your choice.

Allowed values:

  • none (None)
  • layout (Use layout settings)
  • Cabin Sketch
  • Coda
  • Fira Mono
  • Lobster
  • Lora
  • Merriweather
  • Metropolis
  • Montserrat
  • Noto Sans
  • Nunito
  • Open Sans
  • Oswald
  • Overpass Mono
  • Playfair Display
  • PT Sans Narrow
  • PT Sans Caption
  • PT Sans
  • Quicksand
  • Roboto Condensed
  • Roboto
  • Source Sans Pro

map.style_font_weight number

Weight.

Min: 100

Max: 900

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

Projection.

Allowed values:

  • Albers (30° & 45°)
  • Albers USA
  • August
  • Azimuthal Equidistant
  • Aitoff
  • Baker
  • Boggs
  • Braun's Stereographic
  • Bromley
  • Craster Parabolic
  • Eckert I
  • Eckert II
  • Eckert III
  • Eckert IV
  • Eckert V
  • Eckert VI
  • Eisenlohr
  • Equirectangular
  • Fahey
  • Foucaut
  • Ginzburg IV
  • Ginzburg V
  • Ginzburg VI
  • Ginzburg VIII
  • Ginzburg IX
  • Gnomonic
  • Hammer
  • Kavrayskiy VII
  • McBryde–Thomas Flat-Polar Parabolic
  • McBryde–Thomas Flat-Polar Quartic
  • McBryde–Thomas Flat-Polar Sinusoidal
  • Miller (modified Mercator)
  • Mollweide
  • Natural Earth I
  • Natural Earth II
  • Orthographic
  • Robinson
  • Sinusoidal
  • Stereographic
  • Wagner IV
  • Wagner VI
  • Winkel Tripel

map.projection_background_color color

Background color.

map.projection_ocean_color color

Ocean color.

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

Centre long..

map.projection_latitude number

Centre lat..

map.projection_roll number

Rotation.

map.graticules.enabled boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

map.graticules.color color

Colour.

map.graticules.width number

Width.

Max: 10

map.graticules.opacity number

Opacity.

Max: 100

map.graticules.longitude_step number

Longitude separation (°).

Max: 90

map.graticules.latitude_step number

Latitude separation (°).

Max: 90

Viewport and interaction

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. Selecting "world" will display the whole world within the viewport, regardless of your data or settings.

Allowed values:

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

map.map_initial_pitch_tiles number

Pitch. The amount of vertical rotation to apply to the map when it first loads. At zero the map will face completely top-down. Increasing the value to larger values will give the map the illusion of a 3D perspective.

Max: 60

map.map_initial_bearing_tiles number

Bearing. The direction the map should face when it first loads, in degrees. When set to zero the map will load facing north, at 180 the map will face south, and so on.

Min: -180

Max: 180

map.map_initial_pitch_projection number

Pitch. The amount of vertical rotation to apply to the map when it first loads. At zero the map will face completely top-down. Increasing the value to larger values will give the map the illusion of a 3D perspective.

Max: 60

map.map_initial_bearing_projection number

Bearing. The direction the map should face when it first loads, in degrees. When set to zero the map will load facing north, at 180 the map will face south, and so on.

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_lng_min number

Min longitude.

Min: -180

Max: 180

map.map_initial_bounds_lat_min number

Min latitude.

Min: -90

Max: 90

map.map_initial_bounds_lng_max number

Max longitude.

Min: -180

Max: 180

map.map_initial_bounds_lat_max number

Max latitude.

Min: -90

Max: 90

map.map_aspect_type string

Resize by aspect ratio.

Allowed values:

  • none (None)
  • custom (Custom)

map.map_aspect_w number

Width.

Min: 1

map.map_aspect_h number

Height.

Min: 1

map.map_zoom_min number

Min zoom. Limit the map's zoom level so that the user cannot zoom out past a certain point.

Max: 22

map.map_zoom_max number

Max zoom. Limit the map's zoom level so that the user cannot zoom in past a certain point.

Max: 22

map.map_bound_position boolean

Limit viewport bounds. Enable this setting to restrict the viewport within a specific bounding box.

map.map_lng_min number

Min viewport longitude.

Min: -180

Max: 180

map.map_lat_min number

Min viewport latitude.

Min: -90

Max: 90

map.map_lng_max number

Max viewport longitude.

Min: -180

Max: 180

map.map_lat_max number

Max viewport latitude.

Min: -90

Max: 90

map.map_render_world_copies boolean

Repeat map horizontally. The map will display copies of the world on either side at higher zoom levels by default. Disable this if you would prefer only the one copy be visible.

map.animation_enabled boolean

Animate zoom & panning.

map.animation_speed number

Speed.

Min: 0.01

Max: 4

map.map_interactive boolean

Allow user interaction.

map.controls_allow_rotation boolean

Allow rotation.

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)

Regions

map.regions.extrude.enabled boolean

Extrude regions.

map.regions.extrude.min_height number

Min height.

map.regions.extrude.max_height number

Max height.

map.regions.colors.scale_type string

Scale type.

Allowed values:

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

map.regions.colors.categorical_type string

Allowed values:

  • palette (Palette)
  • generated (Generated)

map.regions.colors.categorical_palette colors

Palette.

map.regions.colors.categorical_extend boolean

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

map.regions.colors.categorical_seed_color color

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

map.regions.colors.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

map.regions.colors.categorical_color_space string

Allowed values:

  • hcl (HCL)
  • hsl (HSL)

map.regions.colors.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)

map.regions.colors.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

map.regions.colors.sequential_custom_min color

Minimum color.

map.regions.colors.sequential_custom_max color

Maximum color.

map.regions.colors.sequential_color_space string

Allowed values:

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

map.regions.colors.sequential_reverse boolean

Reverse.

map.regions.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
  • Custom

map.regions.colors.diverging_custom_min color

Minimum color.

map.regions.colors.diverging_custom_mid color

Midpoint color.

map.regions.colors.diverging_custom_max color

Maximum color.

map.regions.colors.diverging_color_space string

Allowed values:

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

map.regions.colors.diverging_reverse boolean

Reverse.

map.regions.colors.binning boolean

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

Allowed values:

  • false (Linear)
  • true (Binned)

map.regions.colors.bin_count number

Number of bins.

map.regions.colors.bin_mode string

Binning mode.

Allowed values:

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

map.regions.colors.bin_thresholds string

Custom thresholds. Write your custom thresholds, separated by a ";" For example 5;10;15

map.regions.use_fallback boolean

Use fallback colour. When enabled, a colour of your choice is used when the value or category binding has not been enabled for your map, or if a value is invalid. Otherwise invalid numbers will be treated as zero, and empty categories will be included in the colour palette.

Allowed values:

  • true (Enable)
  • false (Disable)

map.regions.fill_default color

Fallback colour.

map.regions.opacity number

Region fill opacity.

Max: 100

map.regions.outline.enabled boolean

Enabled.

map.regions.outline.width number

Width.

Min: 0.2

Max: 4

map.regions.outline.color color

Colour.

controls_region_value.control_type string

Control type. These controls will show up when more than 1 value column has been selected

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

controls_region_value.control_styles boolean

Adv..

controls_region_value.button_group boolean

Grouped.

Allowed values:

  • true (On)
  • false (Off)

controls_region_value.button_group_width_mode string

Button group width.

Allowed values:

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

controls_region_value.button_group_width_fixed number

Width.

Max: 100

controls_region_value.dropdown_width_mode string

Dropdown width.

Allowed values:

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

controls_region_value.dropdown_width_fixed number

Width.

Max: 100

controls_region_value.slider_background_color color

Background.

controls_region_value.slider_font_color color

Text.

controls_region_value.slider_handle_color color

Handle.

controls_region_value.slider_width number

Width.

Max: 100

controls_region_value.slider_margin number

Label width.

Max: 50

controls_region_value.slider_handle_height number

Height.

Max: 10

controls_region_value.slider_track_height number

Track height.

Max: 10

controls_region_value.slider_play_button boolean

Play button.

controls_region_value.slider_loop boolean

Loop.

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

controls_region_value.slider_restart_pause number

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

Max: 100

controls_region_value.sort string

Sorting.

Allowed values:

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

controls_region_value.sort_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)

controls_style.font_size number

Text size.

Max: 5

controls_style.font_weight string

Text weight.

Allowed values:

  • bold (Bold)
  • normal (Normal)

controls_style.padding number

Height. Space below and above controls text

Max: 5

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

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

Points

map.points.style string

Appearance.

Allowed values:

  • pulse (Pulses)
  • circle (Circles)

default_color color

Default color.

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.

map.points.colors.scale_type string

Scale type.

Allowed values:

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

map.points.colors.categorical_type string

Allowed values:

  • palette (Palette)
  • generated (Generated)

map.points.colors.categorical_palette colors

Palette.

map.points.colors.categorical_extend boolean

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

map.points.colors.categorical_seed_color color

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

map.points.colors.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

map.points.colors.categorical_color_space string

Allowed values:

  • hcl (HCL)
  • hsl (HSL)

map.points.colors.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)

map.points.colors.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

map.points.colors.sequential_custom_min color

Minimum color.

map.points.colors.sequential_custom_max color

Maximum color.

map.points.colors.sequential_color_space string

Allowed values:

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

map.points.colors.sequential_reverse boolean

Reverse.

map.points.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
  • Custom

map.points.colors.diverging_custom_min color

Minimum color.

map.points.colors.diverging_custom_mid color

Midpoint color.

map.points.colors.diverging_custom_max color

Maximum color.

map.points.colors.diverging_color_space string

Allowed values:

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

map.points.colors.diverging_reverse boolean

Reverse.

map.points.colors.binning boolean

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

Allowed values:

  • false (Linear)
  • true (Binned)

map.points.colors.bin_count number

Number of bins.

map.points.colors.bin_mode string

Binning mode.

Allowed values:

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

map.points.colors.bin_thresholds string

Custom thresholds. Write your custom thresholds, separated by a ";" For example 5;10;15

blend_mode string

Blend mode. Determines how point colors mix with the map or points beneath them. Additive adds the colours together making points 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)

map.points.opacity number

Point opacity.

Max: 100

map.points.stroke_mode string

Outline mode. Choose Auto for outline colour to match point colour. Choose Fixed to give all points a uniform outline colour.

Allowed values:

  • none (None)
  • auto (Auto)
  • fixed (Fixed)

map.points.stroke_opacity number

Opacity.

Max: 100

map.points.stroke_width number

Width.

Max: 10

map.points.stroke_color color

Colour.

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

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:

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

count_by string

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

Allowed values:

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

empty_category_include boolean

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

Allowed values:

  • true (Enable)
  • false (Disable)

empty_category_label string

Label.

display_below_labels boolean

Draw map labels in front of points.

Timeline

timeline.enabled boolean

Allowed values:

  • true (Enabled)
  • false (Disabled)

timeline.style string

Style.

Allowed values:

  • timeline (Timeline)
  • button (Playback button)

timeline.color_axes color

Axes color.

timeline.date_format_display string

X axis date format.

Predefined values:

  • (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)
  • %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.axis_nice_x boolean

Clean X axis. Rounds out the X axis so that its start and end values are nice, round numbers

timeline.axis_nice_y boolean

Clean Y axis. Rounds out the Y axis so that its start and end values are nice, round dates

timeline.scrubber_snap boolean

Snap when scrubbing. When turned on, you can only jump to values that are supplied in the dataset and nothing in between

timeline.play_on_load boolean

Play on load.

timeline.loop boolean

Loop timeline. When turned on, the timeline will return to the beginning once complete. Otherwise, it will stop when it reaches the end.

timeline.scrubber_height number

Scrubber height.

timeline.margin.top number

Top.

timeline.margin.left number

Left.

timeline.margin.bottom number

Bottom.

timeline.margin.right number

Right.

timeline.playback_button.margin_right number

Space between button and timeline.

timeline.playback_button.margin_right_button number

Space between button and text.

timeline.graph boolean

Visibility.

Allowed values:

  • true (Show)
  • false (Hide)

timeline.color_background color

Background.

timeline.curve boolean

Curved lines.

timeline.graph_height number

Graph height.

timeline.playback_button.button_color color

Button colour.

timeline.playback_button.button_size number

Button size.

Max: 8

timeline.playback_button.icon_color color

Icon colour.

timeline.playback_button.icon_size number

Icon size.

Max: 8

timeline.playback_button.label_size number

Label size.

Max: 8

timeline.duration number

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

timeline.duration_tween number

Time transition duration (s). Duration of transitions between different points in time on the timeline. This is the transition you see in the story player when switching between slides with a different time one the timeline.

timeline.duration_wait_at_end number

Time spent before looping (s). Amount of time to wait at the end of the timeline before looping.

timeline.duration_pulse number

Pulse duration. The amount of time that it takes for an point to appear and disappear (in seconds).

counter_bin_mode string

Aggregation options.

Allowed values:

  • both (User controllable)
  • rate (Rate)
  • total (Total)

counter_label_rate string

"Rate" button.

counter_label_total string

"Total" button.

counter_options_type string

Aggregation rate interval.

Allowed values:

  • auto (Auto)
  • custom (Custom)

counter_options_seconds boolean

Seconds.

counter_options_minutes boolean

Minutes.

counter_options_hours boolean

Hours.

counter_options_days boolean

Days.

counter_options_weeks boolean

Weeks.

counter_options_months boolean

Months.

counter_options_years boolean

Years.

Counter

counter_enabled boolean

Enable counter.

Allowed values:

  • true (Enabled)
  • false (Disabled)

counter_layout string

Layout.

Allowed values:

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

counter_position string

Position.

Allowed values:

  • top (fa-arrow-up)
  • bottom (fa-arrow-down)

counter_hide_values boolean

Hide counter values.

counter_colorize boolean

Colour values based on category.

counter_category_order_enabled boolean

Manually select category order.

counter_category_order text

Category order. Include your categories in the order you want them to appear, with one category per line.

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.

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

Selection type.

Allowed values:

  • true (Click)
  • false (Hover)

Cycle through popups over time.

Only cycle through visible points. Points out of the frame will not be selected when cycling through popups.

Cycle interval (s).

Min: 0.5

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

Main font. This font will apply to the whole graphic by default, but 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, but 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 maximum width to just the main graphic or everything (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 (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.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.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_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. 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

Change subtitle styles.

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

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

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

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 colour is dark

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)

layout.footer_border_space number

Space. Space between border and footer text