openlayers/src/ol/README.md

ol

OpenLayers as ES modules.

Usage

Add the ol package as a dependency to your project.

npm install ol --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
  })
});

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

• Using Rollup
• Using Webpack
• Using Parcel

Module Identifiers

The module identifiers shown in the above snippet (e.g. ol/Map, note the CamelCase module name) are default exports of constructors. There are also modules like 'ol/proj' (note the lowercase module name), which provide named exports for utility functions and constants, e.g.

import {fromLonLat} from 'ol/proj';

map.setCenter(fromLonLat([16, 48]));

See the API documentation for a reference of all modules, and just keep in mind: CamelCase modules provide a default export, lowercase modules provide named exports.