A light and plugable JavaScript library for integrated 2D/3D maps.
JavaScript Other
Latest commit b810447 Aug 14, 2018

README.md

NPM Version Circle CI Build status Build Status codecov devDependency Status

A light JavaScript library to create integrated 2D/3D maps.

  • 2D/3D: Integrated 2D/3D maps.
  • Open and pluggable: Easy to extend with techs you may love as plugins.
  • Performant: Can smoothly render tens of thousands of geometries.
  • Simple: Extremely easy to learn and use.
  • Feature Packed: Essential features for most mapping needs.
  • SSR: Server-Side Rendering

The Story

maptalks.js was born for a map-centric project to help YUM! China (the most successful food chain in China) manage and analyze spatial data all over the country for choosing locations of new KFC and PizzaHut restaurants. After verified in many projects of government depts and enterprises, we are glad to open source it, and hoping it can help you deliver better mapping projects.

Resources

Supported Enviroments

  • Modern browsers and IE9+ (only IE11 for 3D features)
  • Mobile browsers
  • Node >= 4.x (for Server-Side Rendering)
  • Electron

maptalks is well tested against IE9, IE10, IE11, Firefox and Chrome by more than 1.6K test cases running on CI services.

Install

  • Standalone file

Download the lastest release and load it in your HTML page like:

<link href="path/to/maptalks.css" rel="stylesheet" type="text/css" />
<script src="path/to/maptalks.min.js" type="text/javascript"></script>
  • CDN Just include this in your html:
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/maptalks/dist/maptalks.min.css">
<script src="https://cdn.jsdelivr.net/npm/maptalks/dist/maptalks.min.js"></script>
  • NPM
npm install maptalks --save

Plugin Development

It's easy and joyful to write plugins for maptalks, please check out the tutorials and begin to develop your own. And you are welcome to share your work with us.

Contributing

We warmly welcome any kind of contributions including issue reportings, pull requests, documentation corrections, feature requests and any other helps.

Contributing Guide

Please read our contributing guide to learn about our development process, how to propose fixes and improvements, and how to test your changes to maptalks.

Acknowledgments

Maptalks is built on the shoulders of giants. Please refer to ACKNOWLEDGEMENT for details.