0.1.3 • Published 3 years ago

vue-chart-map v0.1.3

Weekly downloads
54
License
ISC
Repository
-
Last release
3 years ago

Vue Chart Map

A Vue JS Component for displaying dynamic data on a world map.

preview

Credits

Installation

Install via npm using npm install vue-chart-map

import MapChart from 'vue-chart-map'

Usage

This component is most useful in creating a heat map for various countries. And will color countries differently based on a props passed.

The component requires a prop of countryData to be passed to it, which is a JS object formatted like so.

{
  "US": 100,
  "CA": 120,
  "GB": 400,
}

Where the key is a country's ISO 3166 Code and the value is a numerical value associated with it.

Example:

import MapChart from 'vue-map-chart'

<MapChart
  :countryData="{'US': 4, 'CA': 7, 'GB': 8, 'IE': 14, 'ES': 21}"
  highColor="#ff0000"
  lowColor="#aaaaaa"
  countryStrokeColor="#909090"
  defaultCountryFillColor="#dadada"
  LangUser="fr"
  />

API

PropsDescriptionOptionalType
countryDataSee Usage Section above for detailsnoObject
lowColorCountries with lower values will be colored more strongly with this coloryesString
highColorCountries with higher values will be colored more strongly with this coloryesString
defaultCountryFillColorCountries with no data will default to this coloryesString
countryStrokeColorThe color of the border around countriesyesString
legendBorderColorThe color of the legend's borderyesString
legendBorderRadiusThe radius of the legend's borderyesNumber
legendHeaderBackgroundColorThe background color of the legend's headeryesString
legendContentBackgroundColorThe background color of the legend's contentyesString
legendFontColorHeaderThe font color of the legend's headeryesString
legendFontColorContentThe font color of the legend's contentyesString
positionLeftTooltipChoose the left position of the tooltip in relation to the mouse, like 3 or -13yesNumber
positionTopTooltipchoose the Top position of the tooltip in relation to the mouse, like 3 or -13yesNumber
legendBorderCssAdd CSS box-shadow property example: "1px solid #fff"yesString
legendBoxShadowCssAdd CSS border property example: "0px 0px 15px #fff"yesString
showLegend(WIP) If true, when you select a country a legend will appear on the screenWIPBoolean
showEmptyValueIf false, does not display the countries in hover, if no value is passed for this country in countryDatayesBoolean
LangUserChange the language of the names of countries with an ISO code like "fr", default is "en"yesString
currencyAddIf you want to add currency to your values like 2.45 -> $2.45yesBoolean
currencyOnlySignIf you only want the currency sign in the other like lang 2.45 $US -> 2.45$yesBoolean
currencyCurrentIf you want to change the currency (ISO 4217) lang 2.45 $ -> 2.45 €yesString

Roadmap

  • Change Map type (World, Europe, single country, etc...) (WIP)
  • Click events
  • More customization
  • Export PDF/CSV
0.1.3

3 years ago

0.1.2

4 years ago

0.1.1

4 years ago

0.1.0

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.5

4 years ago

0.0.4

4 years ago

0.0.6

4 years ago

0.0.3

4 years ago

0.0.2

4 years ago

0.0.1

4 years ago