/jvectormap-rails4

jvectormap-rails4

Primary LanguageRubyOtherNOASSERTION

Jvectormap::Rails4

jVectorMap for the Rails asset pipeline

Installation

Add this line to your application's Gemfile:

gem 'jvectormap-rails4'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jvectormap-rails4

Usage

You can add jvectormap-rails to your application.js file using a require statement like this:

//= require jvectormap

To add support for whatever maps you want to use, include them from the jvectormap/maps path:

//= require jvectormap
//= require jvectormap/maps/us_merc_en

The basic pattern is {country}-{region}_{city}_{projection}_{language}. For example, the map us-il-chicago_mill_en has a country of us (United States), region of il (Illinois), city of chicago, projection of mill (Miller), and a language of en (English). Other common projections include Mercator (merc), and Albers equal area (aea).

Asset Precompilation

jvectormap-rails supports precompiling individual maps. Add an initializer to your app, eg. config/initializers/jvectormap.rb:

JVectorMap::Rails.precompile_maps << "us_merc_en"

Rake Tasks

Get a list of all available maps by running this from within your Rails app's root:

bundle exec rake jvectormap:maps

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request