Region map (3D)
Updated 6 years ago to v1.3.0 by Flourish team
How to use this template
What's it for?
Use this template to visualize regions on a map, setting the colour and height of each region to visualize properties in the data.
How to get started
You'll need a GeoJSON file, containing the polygons of the regions you want to map. The coordinates should be WGS84 (unprojected). (You can use Mapshaper or similar tools to convert your data to WGS84 if necessary.)
Not sure how to upload your data to Flourish? See our handy guide
FAQ
How do I reset the initial zoom and centre of the map? For the moment, you need to do this: (1) Create a story from your visualisation (2) Zoom and pan the slide to adjust the zoom and centre of the map (3) In the left-hand menu, under "Navigation", choose "None" (4) Publish the story.
How can I highlight different points on the map? Create a story from your visualisation, then add multiple slides to highlight different views of the data. Pan the map by dragging, and hold down Alt, Ctrl or Shift while dragging to change the angle of view.
Examples
Coming soon!
Credits
Created by the Flourish team, using deck.gl and Mapbox GL JS. Want to see additional features? Let us know at support@flourish.studio.
The default shading data is from: U.S. Census Bureau, 2009-2013 5-Year American Community Survey. Table DP03 “SELECTED ECONOMIC CHARACTERISTICS”.
API information
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/3d-region-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: { regions: [ [ "RegionsColumn1Value1", "RegionsColumn2Value1", [ "RegionsColumn1Value2", "RegionsColumn2Value2", [ "RegionsColumn1Value3", "RegionsColumn2Value3", ... ], regions_minimap: [ [ "Regions_minimapColumn1Value1", "Regions_minimapColumn2Value1", [ "Regions_minimapColumn1Value2", "Regions_minimapColumn2Value2", [ "Regions_minimapColumn1Value3", "Regions_minimapColumn2Value3", ... ] } }
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: "@flourish/3d-region-map", version: "1", bindings: { regions: { geojson: 0, // index of a column in your data }, regions_minimap: { } }, data: { regions: [ [ "RegionsColumn1Value1", "RegionsColumn2Value1", [ "RegionsColumn1Value2", "RegionsColumn2Value2", [ "RegionsColumn1Value3", "RegionsColumn2Value3", ... ], regions_minimap: [ [ "Regions_minimapColumn1Value1", "Regions_minimapColumn2Value1", [ "Regions_minimapColumn1Value2", "Regions_minimapColumn2Value2", [ "Regions_minimapColumn1Value3", "Regions_minimapColumn2Value3", ... ] } }
All possible bindings that you can supply are shown in this example:
{ template: "@flourish/3d-region-map", version: "1", bindings: { regions: { geojson: 0, // index of a column in your data color: 1, // index of a column in your data elevation: 2, // index of a column in your data metadata: [3, 4, ...], // index(es) of column(s) in your data }, regions_minimap: { geojson: 0, // index of a column in your data } }, data: { regions: [ [ "RegionsColumn1Value1", "RegionsColumn2Value1", [ "RegionsColumn1Value2", "RegionsColumn2Value2", [ "RegionsColumn1Value3", "RegionsColumn2Value3", ... ], regions_minimap: [ [ "Regions_minimapColumn1Value1", "Regions_minimapColumn2Value1", [ "Regions_minimapColumn1Value2", "Regions_minimapColumn2Value2", [ "Regions_minimapColumn1Value3", "Regions_minimapColumn2Value3", ... ] } }
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:
{ regions: [ { "RegionsHeader1": ..., "RegionsHeader2": ..., ... }, { "RegionsHeader1": ..., "RegionsHeader2": ..., ... }, { "RegionsHeader1": ..., "RegionsHeader2": ..., ... }, ... ], regions_minimap: [ { "Regions_minimapHeader1": ..., "Regions_minimapHeader2": ..., ... }, { "Regions_minimapHeader1": ..., "Regions_minimapHeader2": ..., ... }, { "Regions_minimapHeader1": ..., "Regions_minimapHeader2": ..., ... }, ... ] }
... 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: "@flourish/3d-region-map", version: "1", bindings: { regions: { geojson: "RegionsHeader1", }, regions_minimap: { } }, data: { regions: [ { "RegionsHeader1": ..., "RegionsHeader2": ..., ... }, { "RegionsHeader1": ..., "RegionsHeader2": ..., ... }, { "RegionsHeader1": ..., "RegionsHeader2": ..., ... }, ... ], regions_minimap: [ { "Regions_minimapHeader1": ..., "Regions_minimapHeader2": ..., ... }, { "Regions_minimapHeader1": ..., "Regions_minimapHeader2": ..., ... }, { "Regions_minimapHeader1": ..., "Regions_minimapHeader2": ..., ... }, ... ] } }
All possible bindings that you can supply are shown in this example:
{ template: "@flourish/3d-region-map", version: "1", bindings: { regions: { geojson: "RegionsHeader1", color: "RegionsHeader2", elevation: "RegionsHeader3", metadata: ["RegionsHeader4", "RegionsHeader5", ...], }, regions_minimap: { geojson: "Regions_minimapHeader1", } }, data: { regions: [ { "RegionsHeader1": ..., "RegionsHeader2": ..., ... }, { "RegionsHeader1": ..., "RegionsHeader2": ..., ... }, { "RegionsHeader1": ..., "RegionsHeader2": ..., ... }, ... ], regions_minimap: [ { "Regions_minimapHeader1": ..., "Regions_minimapHeader2": ..., ... }, { "Regions_minimapHeader1": ..., "Regions_minimapHeader2": ..., ... }, { "Regions_minimapHeader1": ..., "Regions_minimapHeader2": ..., ... }, ... ] } }
(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: "@flourish/3d-region-map", version: "1", data: { regions: [ { geojson: ..., metadata: [...] }, ... ] }, ... }
And the full list of all possible properties is as follows:
{ template: "@flourish/3d-region-map", version: "1", data: { regions: [ { geojson: ..., color: ..., elevation: ..., metadata: [...] }, ... ], regions_minimap: [ { geojson: ... }, ... ] }, ... }
Meanings of the template data keys:
- regions.geojson: geojson
- regions.color: Optionally, a column containing the values used to determine the fill colour of each shape. If these are categories, you should set the fill's scale type to "Categorical" in the visualisation settings. If these are numerical values, you should set the scale type to either "Sequential" or "Diverging"
- regions.elevation: Optionally, a column containing the elevation values for each shape.
- regions.metadata: metadata
- regions_minimap.geojson: geojson
Template settings
Options for opts.state
.
Regions
geojson.geojson_elevation_enabled boolean
Extrude shapes.
geojson.geojson_elevation_normalize string
Normalize elevation. Allowed values:
geojson.geojson_elevation_scale number
Elevation scale.
geojson.geojson_stroke_enabled boolean
Enable stroke.
geojson.geojson_stroke_color color
Stroke color.
geojson.geojson_fill_enabled boolean
Enable fill.
geojson.geojson_color.scale_type string
Scale type. Allowed values:
geojson.geojson_color.categorical_type string
Allowed values:
- palette (Palette)
- generated (Generated)
geojson.geojson_color.categorical_palette colors
Palette.
geojson.geojson_color.categorical_extend boolean
Auto-extend. Automatically generate additional colours when needed to avoid the palette colours being used more than once.
geojson.geojson_color.categorical_seed_color color
Seed color. Initial color in generated sequence (avoid shades of grey).
geojson.geojson_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
geojson.geojson_color.categorical_color_space string
Allowed values:
- hcl (HCL)
- hsl (HSL)
geojson.geojson_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:
Party 1: red
Party 2: #4455AA
Party 3: rgb(30,168,26)
geojson.geojson_color.sequential_palette string
Palette. Allowed values:
geojson.geojson_color.sequential_custom_min color
Minimum color.
geojson.geojson_color.sequential_custom_max color
Maximum color.
geojson.geojson_color.sequential_color_space string
Allowed values:
- rgb (RGB)
- lab (LAB)
- hcl (HCL)
- hsl (HSL)
geojson.geojson_color.sequential_reverse boolean
Reverse scale.
geojson.geojson_color.diverging_palette string
Palette. Allowed values:
geojson.geojson_color.diverging_custom_min color
Minimum color.
geojson.geojson_color.diverging_custom_mid color
Midpoint color.
geojson.geojson_color.diverging_custom_max color
Maximum color.
geojson.geojson_color.diverging_color_space string
Allowed values:
- rgb (RGB)
- lab (LAB)
- hcl (HCL)
- hsl (HSL)
geojson.geojson_color.diverging_reverse boolean
Reverse scale.
geojson.geojson_fill_color color
Fallback colour. Fill colour to use if a colour value is missing or invalid for a shape.
geojson.geojson_opacity number
Shape opacity. Max: 1
Base map
map.style_base string
Map style. Allowed values:
map.style_show_borders boolean
Display borders.
map.style_show_roads boolean
Display roads.
map.style_show_labels boolean
Display labels.
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:
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:
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:
map.controls_fullscreen_enabled boolean
Use fullscreen control.
map.controls_fullscreen_alignment string
Fullscreen control position. Allowed values:
map.animation_enabled boolean
Enable animation.
map.animation_duration number
Duration. 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:
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:
popup.is_custom boolean
Popup contents. Allowed values:
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:
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
Number 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:
format_popup.prefix string
Prefix. Text to place in front of number
format_popup.suffix string
Suffix. Text to place after number
format_popup.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
format_popup.strip_zeros boolean
Remove trailing zeros.
format_popup.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”.
format_popup.transform_labels boolean
Multiply/divide values.
format_popup.transform string
Allowed values:
- multiply (Multiply by)
- divide (Divide by)
- exponentiate (×10 to the power of)
format_popup.multiply_divide_constant number
format_popup.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.background_color color
Background.
layout.margin number
Margin.
layout.layout_order string
Layout order. Allowed values:
layout.space_between_sections string
Space between sections. Allowed values:
layout.space_between_sections_custom number
Custom. Max: 100
Header
layout.header_align string
Alignment. Allowed values:
layout.title string
layout.title_styling boolean
Change title styles.
layout.title_size string
Size. Allowed values:
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:
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:
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:
layout.subtitle_color color
Color.
layout.subtitle_line_height number
Line height. Max: 3
layout.subtitle_space_above string
Space above. Allowed values:
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:
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:
layout.text_color color
Color.
layout.text_line_height number
Line height. Max: 3
layout.text_space_above string
Space above. Allowed values:
layout.text_space_above_custom number
Custom. Max: 100
Footer
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:
layout.logo_url url
Image.
layout.logo_link_url string
Link.
layout.logo_height number
Height.
layout.logo_margin number
Margin.
layout.logo_order string
Position. Allowed values:
layout.footer_align_vertical string
V. align. Allowed values: