OpenLayers

A high-performance, feature-packed library for creating interactive maps on...

Maps
openlayers/openlayersopenlayers.orgol

README

OpenLayers


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 BSD 2-Clause License.

Getting Started


Install the [ol package](https://www.npmjs.com/package/ol):

  1. ```
  2. npm install ol
  3. ```

Import just what you need for your application:

  1. ``` js
  2. import Map from 'ol/Map';
  3. import View from 'ol/View';
  4. import TileLayer from 'ol/layer/Tile';
  5. import XYZ from 'ol/source/XYZ';

  7. new Map({
  8.   target: 'map',
  9.   layers: [
  10.     new TileLayer({
  11.       source: new XYZ({
  12.         url: 'https://tile.openstreetmap.org/{z}/{x}/{y}.png'
  13.       })
  14.     })
  15.   ],
  16.   view: new View({
  17.     center: [0, 0],
  18.     zoom: 2
  19.   })
  20. });
  21. ```

See the following examples for more detail on bundling OpenLayers with your application:

Using Vite
Using Rollup
Using webpack
Using Parcel

For more detail on quick prototyping without the use of a Node.js based setup, see the Skypack example.

Sponsors


OpenLayers appreciates contributions of all kinds.  We especially want to thank our fiscal sponsors who contribute to ongoing project maintenance.
Pozi logo

Pozi helps connect communities through spatial thinking.

We love Openlayers and it forms a core part of our platform.

https://pozi.com/ https://app.pozi.com/

yey'maps logo

yey'maps is a scalable cloud GIS suite that is developed with the

powerful Openlayers API and the GDAL library.

https://www.yeymaps.io/

GeoSolutions logo

Your one-stop-shop for geospatial open source software.

https://www.geosolutionsgroup.com/

ela-compil logo

We develop leading Physical Security Information Management (PSIM) software.

OpenLayers is the core of our map engine and we love it!

https://ela.pl/

Ubigu Oy logo

We advance holistic utilization and availability of spatial information,

for a better planned, built and managed society.

https://www.ubigu.fi/


See our GitHub sponsors page or Open Collective if you too are interested in becoming a regular sponsor.

TypeScript support


The ol package includes auto-generated TypeScript declarations as*.d.ts files.

Supported Browsers


OpenLayers runs on all modern browsers (with greater than 1% global usage).  This includes Chrome, Firefox, Safari and Edge. For older browsers, polyfills will likely need to be added.

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


- Need help? Find it on Stack Overflow using the tag 'openlayers'
- Follow @openlayers on Twitter

Test Status