openlayers/package/readme.md

ol

OpenLayers as ES2015 modules.

Note: This is still a work in progress. Not yet ready for production.

Usage

Add the ol package as a dependency to your project.

npm install ol@beta --save

Import just what you need for your application:

import Map from 'ol/map';
import View from 'ol/view';
import TileLayer from 'ol/layer/tile';
import XYZ from 'ol/source/xyz';

new Map({
  target: 'map',
  layers: [
    new TileLayer({
      source: new XYZ({
        url: 'https://{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png'
      })
    })
  ],
  view: new View({
    center: [0, 0],
    zoom: 2
  })
});

Note that the module identifiers above (e.g. ol/map) are like the ol.Map names in the API documentation with / instead of . and all lowercase.

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

• Using Rollup & Uglify
• Using Rollup & Closure Compiler
• Using Webpack & Uglify
• Using Browserify & Uglify

This is still a work in progress. See openlayers/openlayers#6302 for ongoing discussion.