Releases: openlayers/openlayers
v5.1.2
v5.1.1
The 5.1.1 release is a patch to include the readme in the package. See the 5.1.0 notes for detail on the 5.1 release.
v5.1.0
The 5.1 release adds a few new features a handful of fixes. You should be able to upgrade without any additional work. See the one note below regarding null
geometry coordinates.
We're working toward type checking with TypeScript. This will complete our move away from using the Closure Compiler for type checking and compilation. We're excited about the improved experience for application developers and will highlight some of the benefit in upcoming releases.
Upgrade Notes
Geometry constructor and setCoordinates
no longer accept null
coordinates
Geometries (ol/geom/*
) now need to be constructed with valid coordinates (center for ol/geom/Circle
) as first constructor argument. The same applies to the setCoordinates()
(setCenter() for
ol/geom/Circle`) method.
New Features and Fixes
- #8409 - Add abstract translate to ol/geom/Geometry (@pjeweb)
- #8405 - Minor type fixes (@tschaub)
- #8401 - Make webpack's css loader work (@ahocevar)
- #8403 - Markdown links (@tschaub)
- #8402 - Type fixes from the typescript checks (@fredj)
- #8400 - ESLint config update (@tschaub)
- #8399 - Copy ol.css to build dir when building package (@ahocevar)
- #8397 - Update rollup (@tschaub)
- #8385 - Use class syntax (@openlayers)
- #8383 - style/Icon: Add
setAnchor()
method (@Turbo87) - #8368 - Make render listeners work with image render mode (@ahocevar)
- #8376 - copy ZM values to polygon in makeRegular (@virtualcitySYSTEMS)
- #8372 - Release v5.0.3 (@openlayers)
- #8364 - Make examples work in IE11 (@ahocevar)
- #8363 - Autogenerate src/ol/package.json (@ahocevar)
- #8371 - Skip rendering when there is no replay group (@ahocevar)
- #8362 - Smart flat coordinates (@ahocevar)
- #8352 - Set
sideEffects
tofalse
instead of"false"
(@tschaub) - #8351 - Fix typo in release notes (@ahocevar)
- #8350 - Updates for v5.0.2 (@ahocevar)
- #8349 - Release v5.0.1 (@ahocevar)
- #8343 - Starter projects (@tschaub)
- #8347 - Fix typos in release notes (@ahocevar)
- #8346 - Release v5.0.1 (@openlayers)
- #8342 - Fix links and description in quickstart tutorial (@ahocevar)
- #8344 - Updated issue and pr templates (@tschaub)
- #8341 - Set sideEffects: false flag (@ahocevar)
- #8333 - Fix wrong return type for readHref function (@openlayers)
- #8329 - Better jsdoc typing (@fredj)
- #8319 - Remove reference to setProj4 function in documentation (@fredj)
Dependency Updates
- #8410 - Update rollup to the latest version 🚀 (@openlayers)
- #8408 - Update rollup to the latest version 🚀 (@openlayers)
- #8386 - Update fs-extra to the latest version 🚀 (@openlayers)
- #8382 - Update webpack to the latest version 🚀 (@openlayers)
- #8373 - Update webpack to the latest version 🚀 (@openlayers)
- #8355 - Update recast to the latest version 🚀 (@openlayers)
- #8354 - Update webpack to the latest version 🚀 (@openlayers)
- #8348 - Update webpack to the latest version 🚀 (@openlayers)
- #8338 - Update recast to the latest version 🚀 (@openlayers)
- #8332 - Update webpack to the latest version 🚀 (@openlayers)
- #8326 - Update webpack to the latest version 🚀 (@openlayers)
- #8321 - Update rollup to the latest version 🚀 (@openlayers)
- #8318 - Update webpack to the latest version 🚀 (@openlayers)
v5.0.3
5.0.2
5.0.1
The v5.0.1 release helps reduce bundle sizes for bundlers that support the "sideEffects": "false"
option in package.json
, and fixes website documentation regarding cdn locations and debug build which has been replaced by source maps.
Fixes
v5.0.0
v5.0.0
The main theme of the v5.0.0 release is an improved developer/user experience with OpenLayers. Toward this end, we have reworked the library as a set of ES Modules, completely removing any dependency on the Closure Compiler, and improving compatibility with mainstream module bundlers.
See the hosted examples, API docs, and bundle tutorial for the new syntax, but basic usage looks like this:
import 'ol/ol.css';
import {Map, View} from 'ol';
import TileLayer from 'ol/layer/Tile';
import OSM from 'ol/source/OSM';
const map = new Map({
target: 'map',
layers: [
new TileLayer({
source: new OSM()
})
],
view: new View({
center: [0, 0],
zoom: 0
})
});
See below for specific notes on upgrading from 4.x releases. We'll be working on updating the website with improved documentation and examples. Take a look at the issue tracker if you're interested in contributing.
Upgrade Notes
Renamed ol/source/TileUTFGrid
to ol/source/UTFGrid
The module name is now ol/source/UTFGrid
(ol.source.UTFGrid
in the full build).
Renaming of the defaultDataProjection
in the options and property of the ol/format/Feature
class and its subclasses
The defaultDataProjection
option is now named dataProjection
. The protected property available on the class is also renamed.
transition
option of ol/source/VectorTile
is ignored
The transition
option to get an opacity transition to fade in tiles has been disabled for ol/source/VectorTile
. Vector tiles are now always rendered without an opacity transition.
ol/style/Fill
with CanvasGradient
or CanvasPattern
The origin for gradients and patterns has changed from the top-left corner of the extent of the geometry being filled to 512 css pixel increments from map coordinate [0, 0]
. This allows repeat patterns to be aligned properly with vector tiles. For seamless repeat patterns, width and height of the pattern image must be a factor of two (2, 4, 8, ..., 512).
Removal of the renderer option for maps
The renderer
option has been removed from the Map
constructor. The purpose of this change is to avoid bundling code in your application that you do not need. Previously, code for both the Canvas and WebGL renderers was included in all applications - even though most people only use one renderer. The Map
constructor now gives you a Canvas (2D) based renderer. If you want to try the WebGL renderer, you can import the constructor from ol/WebGLMap
.
Old code:
import Map from 'ol/Map';
const canvasMap = new Map({
renderer: ['canvas']
// other options...
});
const webglMap = new Map({
renderer: ['webgl']
// other options...
});
New code:
import Map from 'ol/Map';
import WebGLMap from 'ol/WebGLMap';
const canvasMap = new Map({
// options...
});
const webglMap = new WebGLMap({
// options...
});
Removal of ol.FeatureStyleFunction
The signature of the vector style function passed to the feature has changed. The function now always takes the feature
and the resolution
as arguments, the feature
is no longer bound to this
.
Old code:
feature.setStyle(function(resolution) {
var text = this.get('name');
...
});
New code:
feature.setStyle(function(feature, resolution) {
var text = feature.get('name');
...
});
Changed behavior of the Draw
interaction
For better drawing experience, two changes were made to the behavior of the Draw interaction:
- On long press, the current vertex can be dragged to its desired position.
- On touch move (e.g. when panning the map on a mobile device), no draw cursor is shown, and the geometry being drawn is not updated. But because of 1., the draw cursor will appear on long press. Mouse moves are not affected by this change.
Changes in proj4 integration
Because relying on a globally available proj4 is not practical with ES modules, we have made a change to the way we integrate proj4:
- The
setProj4()
function from theol/proj
module was removed. - A new
ol/proj/proj4
module with aregister()
function was added. Regardless of whether the application importsproj4
or uses a globalproj4
, this function needs to be called with the proj4 instance as argument whenever projection definitions were added to proj4's registry with (proj4.defs
).
It is also recommended to no longer use a global proj4
. Instead,
npm install proj4
and import it:
import proj4 from 'proj4';
Applications can be updated by importing the register
function from the ol/proj/proj4
module
import {register} from 'ol/proj/proj4'
and calling it before using projections, and any time the proj4 registry was changed by proj4.defs()
calls:
register(proj4);
Removal of logos
The map and sources no longer accept a logo
option. Instead, if you wish to append a logo to your map, add the desired markup directly in your HTML. In addition, you can use the attributions
property of a source to display arbitrary markup per-source with the attribution control.
Replacement of ol/Sphere
constructor with ol/sphere
functions
The ol/Sphere
constructor has been removed. If you were using the getGeodesicArea
method, use the getArea
function instead. If you were using the haversineDistance
method, use the getDistance
function instead.
Examples before:
// using ol@4
import Sphere from 'ol/sphere';
var sphere = new Sphere(Sphere.DEFAULT_RADIUS);
var area = sphere.getGeodesicArea(polygon);
var distance = sphere.haversineDistance(g1, g2);
Examples after:
// using ol@5
import {circular as circularPolygon} from 'ol/geom/Polygon';
import {getArea, getDistance} from 'ol/sphere';
var area = getArea(polygon);
var distance = getDistance(g1, g2);
var circle = circularPolygon(center, radius);
New signature for the circular
function for creating polygons
The circular
function exported from ol/geom/Polygon
no longer requires a Sphere
as the first argument.
Example before:
// using ol@4
import Polygon from 'ol/geom/polygon';
import Sphere from 'ol/sphere';
var poly = Polygon.circular(new Sphere(Sphere.DEFAULT_RADIUS), center, radius);
Example after:
// using ol@5
import {circular as circularPolygon} from 'ol/geom/Polygon';
var poly = circularPolygon(center, radius);
Removal of optional this arguments.
The optional this (i.e. opt_this) arguments were removed from the following methods. Please use closures, the es6 arrow function or the bind method to achieve this effect (Bind is explained here: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind).
- Collection#forEach
- geom/LineString#forEachSegment
- Observable#on, #once, #un
- Map#forEachLayerAtPixel
- source/TileUTFGrid#forDataAtCoordinateAndResolution
- source/Vector#forEachFeature, #forEachFeatureInExtent, #forEachFeatureIntersectingExtent
Map#forEachLayerAtPixel
parameters have changed
If you are using the layer filter, please note that you now have to pass in the layer filter via an AtPixelOptions
object. If you are not using the layer filter the usage has not changed.
Old syntax:
map.forEachLayerAtPixel(pixel, callback, callbackThis, layerFilterFn, layerFilterThis);
New syntax:
map.forEachLayerAtPixel(pixel, callback, {
layerFilter: layerFilterFn
});
To bind a function to a this, please use the bind method of the function (See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind).
This change is due to the introduction of the hitTolerance
parameter which can be passed in via this AtPixelOptions
object, too.
New Features and Fixes
- #8314 - Accept hitTolerance in map.forEachLayerAtPixel() (@simonseyock)
- #7750 - Don't assume fill for canvas polygon hit detection. (@schmidtk)
- #8305 - Update quickstart and tutorials for v5 (@ahocevar)
- #8301 - Do not render vectors in image mode (@ahocevar)
- #8302 - Ignore node_modules everywhere (@ahocevar)
- #8299 - Make classes in ol/ available as named exports from ol (@ahocevar)
- #8298 - Add README for ol package (@ahocevar)
- #8295 - Prepare for building/publishing v5 (@ahocevar)
- #8296 - Fix style documentation (@fredj)
- #8294 - Remove non-functional type checks from testing (@ahocevar)
- #8292 - Remove now unneeded single quotes in examples (@fredj)
- #8291 - Graticule code cleanup (@fredj)
- [#8287](https://github.com/openlayers/openlayer...
v5.0.0-beta.10
This is a pre-release of OpenLayers 5.0, with the purpose of just providing a full build (ol.js and ol.css).