阿西河

所有教程

公众号
🌙
阿西河前端的公众号

我的收藏

    最近访问  (文章)

      教程列表

      抓包专区
      测试专区

      插件 jQuery.mapael 中文API文档

      插件 jQuery.mapael 中文API文档 https://github.com/neveldo/jquery-Mapael

      jQuery Mapael - Dynamic vector maps

      Build StatusCDNJS

      The complete documentation is available on Mapael website (repository: ‘neveldo/mapael-documentation’).

      Additional maps are stored in the repository ‘neveldo/mapael-maps’.

      The documentation of Raphael.js is available here (mirror).

      Overview

      jQuery Mapael is a jQuery plugin based on raphael.js that allows you to display dynamic vector maps.

      For example, with Mapael, you can display a map of the world with clickable countries. You can also build simple dataviz by setting some parameters in order to automatically set a color depending on a value to each area of your map and display the associated legend. Moreover, you can plot cities on the map with circles, squares or images by their latitude and longitude. Many more options are available, read the documentation in order to get a complete overview of mapael abilities.

      Mapael supports all modern browsers and Internet Explorer 9+. For older versions of IE, you can load jQuery 1.11.x and Raphael.js 2.1.2 as dependencies, most of the jQuery Mapael features should work fine.

      Dataviz example

      See this example !

      Key features

      • based on jQuery and raphael.js. And optionally based on jQuery mousewheel for the zoom on mousewheel feature.
      • Interactive. Set href, tooltip, add events and many more on the elements of your map.
      • Plottable cities Cities can be plotted on the map with circles, squares, images or SVG paths by their latitude and longitude
      • Areas and plotted points colorization with legends. Mapael automatically sets attributes like color and size to each area and plotted point displayed on map and generates an interactive legend in order to build pretty dataviz
      • Links between cities. You can draw links between the cities of the map.
      • Easy to add new maps. Build your own maps based on SVG paths
      • SEO-friendly. An alternative content can be set for non-JS users and web crawlers
      • Resizable Maps are easily resizable.
      • Zoom Zoom and panning abilities (also on mobile devices).

      Installation

      Directly in your page

      Note on dependencies: jQuery and Raphael (and Mousewheel, if needed) must be loaded before Mapael in order to work properly.

      Note on maps: map files must be loaded after Mapael in order to work properly.

      Using CDN

      Include in your project page one of these tags:

      <script src="//cdnjs.cloudflare.com/ajax/libs/jquery-mapael/2.2.0/js/jquery.mapael.min.js"></script>
      <script src="//cdn.jsdelivr.net/npm/jquery-mapael@2.2.0/js/jquery.mapael.min.js"></script>
      

      Using self-hosted

      Download the latest version and extract jquery.mapael.min.js in your project.

      Then, add the script to your page (update the path as needed):

      <script src="path/to/jquery.mapael.min.js"></script>
      

      Using a package manager

      NPM / Yarn

      In your project root, run either commandline:

      npm i --save jquery-mapael
      yarn add jquery-mapael
      

      However, if you don’t need the optional Mousewheel feature (for Zoom feature), then you can use the --no-optional flag to skip optional dependencies.

      Use either:

      npm i --no-optional jquery-mapael
      yarn add --no-optional jquery-mapael
      

      Then in your application:

      require('jquery-mapael');
      

      Or, in ES6:

      import 'jquery-mapael';
      

      Bower

      In your project root, run:

      bower install jquery-mapael --save
      

      Basic code example

      Here is the simplest example that shows how to display an empty map of the world :

      HTML :

          <div class="container">
              <div class="map">Alternative content</div>
          </div>
      

      JS :

          $(".container").mapael({
              map : {
                  name : "world_countries"
              }
          });
      

      Examples

      Basic

      Advanced

      Contributing

      Want to contribute? See the CONTRIBUTING file.

      License

      Copyright (C) 2013-2018 Vincent Brouté

      jQuery Mapael is licensed under the MIT license (http://www.opensource.org/licenses/mit-license.php).

      Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

      The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

      THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

      目录
      目录