Back to Superset

Country Map Tools

docs/versioned_docs/version-6.0.0/configuration/country-map-tools.mdx

2021.41.01.9 KB
Original Source

import countriesData from '../../../data/countries.json';

The Country Map Visualization

The Country Map visualization allows you to plot lightweight choropleth maps of your countries by province, states, or other subdivision types. It does not rely on any third-party map services but would require you to provide the ISO-3166-2 codes of your country's top-level subdivisions. Comparing to a province or state's full names, the ISO code is less ambiguous and is unique to all regions in the world.

Included Maps

The current list of countries can be found in the src legacy-plugin-chart-country-map/src/countries.ts

The Country Maps visualization already ships with the maps for the following countries:

<ul style={{columns: 3}}> {countriesData.countries.map((country, index) => ( <li key={index}>{country}</li> ))} </ul>

Adding a New Country

To add a new country to the list, you'd have to edit files in @superset-ui/legacy-plugin-chart-country-map.

  1. Generate a new GeoJSON file for your country following the guide in this Jupyter notebook.
  2. Edit the countries list in legacy-plugin-chart-country-map/src/countries.ts.
  3. Install superset-frontend dependencies: cd superset-frontend && npm install
  4. Verify your countries in Superset plugins storybook: npm run plugins:storybook.
  5. Build and install Superset from source code.