node package manager

openlayers

OpenLayers

Travis CI Status Greenkeeper badge Coverage Status OSGeo Project

OpenLayers is a high-performance, feature-packed library for creating interactive maps on the web. It can display map tiles, vector data and markers loaded from any source on any web page. OpenLayers has been developed to further the use of geographic information of all kinds. It is completely free, Open Source JavaScript, released under the 2-clause BSD License (also known as the FreeBSD).

Getting Started

Use one of the following methods to use OpenLayers in your project:

  • For use with webpack, Rollup, Browserify, or other module bundlers, install the ol package:

    npm install ol
    
  • If you just want to add a <script> tag to test things out, you can link directly to one of the full builds from cdnjs (not recommended for production)

  • For use with Closure Library (rare), install the openlayers package and read the tutorial.

Supported Browsers

OpenLayers runs on all modern browsers that support HTML5 and ECMAScript 5. This includes Chrome, Firefox, Safari and Edge. For older browsers and platforms like Internet Explorer (down to version 9) and Android 4.x, polyfills for requestAnimationFrame and Element.prototype.classList are required, and using the KML format requires a polyfill for URL.

Documentation

Check out the hosted examples, the workshop or the API documentation.

Bugs

Please use the GitHub issue tracker for all bugs and feature requests. Before creating a new issue, do a quick search to see if the problem has been reported already.

Contributing

Please see our guide on contributing if you're interested in getting involved.

Community