Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 1.98 KB

README.md

File metadata and controls

64 lines (48 loc) · 1.98 KB

atlas-geomap

by the Growth Lab at Harvard's Center for International Development

Modular Geo Map for visualizing import/export data in the Atlas of International Complexity

This package is part of Harvard Growth Lab’s portfolio of software packages, digital products and interactive data visualizations. To browse our entire portfolio, please visit The Viz Hub at growthlab.app. To learn more about our research, please visit Harvard Growth Lab’s home page.

NPM JavaScript Style Guide

Install

npm install --save atlas-geomap

Usage

import React from 'react'
import GeoMap from 'atlas-geomap';

const App = () => {
  ...

  return (
    <GeoMap
      data={data}
      hideTooltip={() => console.log('hide tooltip')}
      showTooltip={(info) => console.log(info)}
      onCountryClick={(countryId) => console.log(countryId)}
      domainEnd={1000000000}
      domainSpectrumEnd={398107170.55349696}
      domainSpectrumStart={10000000}
      domainStart={100000}
      rangeEnd={"#0A4486"}
      rangeStart={"#B1E0BB"}
      showSelectedCountry={true}
    />
  )
}

export default App

The GeoMap component takes the following props:

  • data: CountryData;
  • hideTooltip: () => void;
  • showTooltip: (info: ITooltipInfo) => void;
  • onCountryClick: (countryId: number) => void;
  • domainEnd: number
  • domainSpectrumEnd: number
  • domainSpectrumStart: number
  • domainStart: number
  • rangeEnd: string
  • rangeStart: string
  • showSelectedCountry: boolean

License

MIT © The President and Fellows of Harvard College