Mapchart reference

To represent data related to cartography

Overview

📖 Learn More about the Mapchart here.

📖 Find examples on the Mapchart here.

Parameters

Required

You must fill these parameters to produce a Mapchart

parameters label type description (placeholder | tooltip)
dataset   string |

Optional

You can let these parameters unset if you do not need them

parameters label type description (placeholder | tooltip)
fixed Fixed map boolean | Activate this option to prevent users from zooming onto the map
tiles Background object | This will display a cartographic backgroundThis is mandatory if you only configure Markers You need to save your story and refresh your page to see the changes
tiles/params   object |
tiles/provider   string |
markers Markers object | Pin information on a map
markers/size Markers size   | - Optional -Use a value to size markers
markers/longitude   string (Column of dataset expected) Column containing longitude coordinates | Use coordinates to position your marker
markers/label   string (Column of dataset expected) Column containing markers’ labels | Add labels to your markers
markers/color Markers color string (Column of dataset expected) Column containing value for markers color | - Optional -Use a value to color markers
markers/recycleColors Recycle groups colors boolean | When chart data changes (filters or requesters)
markers/latitude   string (Column of dataset expected) Column containing latitude coordinates | Use coordinates to position your marker
markers/opacity   number Enter a value between 0 and 1 | - Optional -Custom markers opacity0 is completely transparent, 1 completely opaque (default)
markers/defaultSelected Default selected marker string | first, last or the code of the label
markers/meta     | Will be displayed in the legend
projection   string | This is for advanced configuration onlyCheckout this documentation for more info on projections
size Size number Enter a proportion of the total screen | Use on multiple charts onlyEnter a number from 0 to 1
style Custom CSS class string amazing-class | Set a customm CSS class to target this specific chart with CSS
tutorial Tutorial object |
tutorial/alwaysShow Always show this tutorial boolean | By default the tutorial is shown once only
tutorial/content Message string Enter your message | This will be displayed to your users
tutorial/id   string Enter an ID | Change the ID to display the tutorial again. All tutorials with the same ID will be displayed only once.
legend Display legend object |
legend/compact Use exhaustive legend boolean | Show all your zones, ranked and searchable
mobileSize Mobile Size number Enter a proportion of the total mobile screen | Use on multiple charts onlyEnter a number from 0 to 1
zones Color zones object | To use this option make sure you have shapes available.Read this tutorial to learn more about it
zones/label   string (Column of dataset expected) Column containing zones names |
zones/unfilteredDomain Use scaling on unfiltered dataset boolean | By default, the scale is computed with the data after filtering.Set to true for the scale to be consistent across filtering
zones/opacity Zone opacity number Enter a value between 0 and 1 | - Optional -Custom zone’s opacity0 is completely transparent, 1 completely opaque (default)
zones/displayValueOnZones Display values on zones boolean | Display values directly on zones if there’s enough space. Otherwise, it’s clickable by the user.
zones/noDataZones Missing data zones object | Manage the display of zones with no data
zones/noDataZones/disableClickEvent Deactivate user’s selection boolean | Prevent user to select empty zones
zones/noDataZones/color Color string Enter color name or any hexadecimal color | Customize the color of the empty zonesCan be a color name or any hexadecimal color like #000000
zones/quantiles Number of scale’s buckets integer Enter a number of buckets for the scale |
zones/color Color value string (Column of dataset expected) Column containing color value | Use a value to color zones
zones/reverseScale Reverse scale boolean | Reverse scale to set high values as cold and low ones as hot
zones/meta     | Will be displayed in the legend
zones/scale   array |
zones/thresholds Custom color thresholds array Enter a threshold value | - Optional -Override the default quantile scale.You can specify a maximum of 3 custom thresholds.
zones/defaultSelected Default selected zone string | first, last or the code of the label

Others

This parameters are either common to all charts, or hidden from studio. You can use them in code mode, but it’s not recommended !

parameters label type description (placeholder | tooltip)
markers/reverseScale   boolean |
crossfilter   object | Use it for crossfilter configurationShould be configured on the primary chart
crossfilter/datasets Select the filtered datasets array | Datasets that will be filtered on the ‘on’ column
crossfilter/on on column string (Column of dataset expected) Column existing in primary and filtered datasets |
zones/noDataZones/hidden Show zones boolean | Authorize user to see empty zones
zones/id   string (Column of dataset expected) |