With more than 40 pull requests, the 10.4 release brings performance improvements, bug fixes, better TypeScript generics and new features. New features include a convenience Image layer loader for debugging MapServer map files using the MapServer CGI API, and an experimental WebGLVectorTile layer.

Upgrade notes

Deprecation of ol/layer/WebGLPoints

Use ol/layer/WebGLVector instead. Besides rendering points it will also render lines and polygons. In most cases this is a drop-in replacement. To use filtering the style and filter have to be in a nested object.

// Before
new WebGLPointsLayer({
  filter: ['between', ['get', 'year'], ['var', 'minYear'], ['var', 'maxYear']],
  style: {
    'circle-radius': 8,
    'circle-fill-color': 'blue',
  },
  source: vectorSource,
})

// After
new WebGLVectorLayer({
  style: [{
    filter: ['between', ['get', 'year'], ['var', 'minYear'], ['var', 'maxYear']],
    style: {
      'circle-radius': 8,
      'circle-fill-color': 'blue',
    },
  }],
  source: vectorSource,
})

ol/style/webgl module removal

WebGL renderers used to rely on the WebGLStyle type in the ol/style/webgl module. This is not the case anymore, all renderers now rely on FlatStyle from ol/style/flat.

-import type { WebGLStyle } from 'ol/style/webgl';
+import type { FlatStyle } from 'ol/style/flat';

ol-mapbox-style compatibility

This version of OpenLayers is only compatible with ol-mapbox-style@12.4.0 or higher.

Returning false from a one-time listener added with once

Returning false from the listener function will now stop propagation, when the listener is added with once. Previously this only worked with the on method.

The filter option for WebGLPointsLayer has changed

The filter option for the WebGLPointsLayer must now be specified alongside other options instead of being part of the style object. Note that the WebGLPointsLayer is not part of the stable API and is subject to breaking changes between major releases.

// Before
new WebGLPointsLayer({
  style: {
    filter: ['between', ['get', 'year'], ['var', 'minYear'], ['var', 'maxYear']],
    'circle-radius': 8,
    'circle-fill-color': 'blue',
  },
  source: vectorSource,
})

// Now
new WebGLPointsLayer({
  filter: ['between', ['get', 'year'], ['var', 'minYear'], ['var', 'maxYear']],
  style: {
    'circle-radius': 8,
    'circle-fill-color': 'blue',
  },
  source: vectorSource,
})

Get ready for future changes

We're planning to stop providing barrel files, which will impact how you import modules from OpenLayers. See #16461 for details. To get your code ready for that upcoming change, you can already help us test the replace-barrel-imports codemod from the @openlayers/codemod package.

List of all changes

• Updates for the 10.3.1 release by @jahow in https://github.com/openlayers/openlayers/pull/16435
• Bump pmtiles from 3.2.1 to 4.0.1 by @dependabot in https://github.com/openlayers/openlayers/pull/16418
• Skip tiles not in rotated viewport by @MoonE in https://github.com/openlayers/openlayers/pull/16443
• Intersection performance improvements by @MoonE in https://github.com/openlayers/openlayers/pull/16442
• Remove duplicate property from CanvasTileLayerRenderer by @MoonE in https://github.com/openlayers/openlayers/pull/16445
• Updates to work with ESLint 9 by @tschaub in https://github.com/openlayers/openlayers/pull/16441
• Bump dawidd6/action-download-artifact from 6 to 7 by @dependabot in https://github.com/openlayers/openlayers/pull/16421
• Bump @types/geojson from 7946.0.14 to 7946.0.15 by @dependabot in https://github.com/openlayers/openlayers/pull/16447
• Bump puppeteer from 23.9.0 to 23.10.1 by @dependabot in https://github.com/openlayers/openlayers/pull/16448
• Bump rollup from 4.28.0 to 4.28.1 by @dependabot in https://github.com/openlayers/openlayers/pull/16449
• Bump mocha from 10.8.2 to 11.0.1 by @dependabot in https://github.com/openlayers/openlayers/pull/16450
• Bump webpack from 5.96.1 to 5.97.1 by @dependabot in https://github.com/openlayers/openlayers/pull/16451
• Bump express from 4.21.1 to 4.21.2 by @dependabot in https://github.com/openlayers/openlayers/pull/16452
• Change tile state to EMPTY when releasing tiles by @ahocevar in https://github.com/openlayers/openlayers/pull/16455
• fix: check for ImageBitmap support in ImageWrapper load by @rwd in https://github.com/openlayers/openlayers/pull/16458
• Remove expandUrl re-export by @ahocevar in https://github.com/openlayers/openlayers/pull/16459
• Update High DPI WMTS capabilities url by @mike-000 in https://github.com/openlayers/openlayers/pull/16463
• Replace barrel imports in examples by @tschaub in https://github.com/openlayers/openlayers/pull/16465
• Consistent use of relative imports by @tschaub in https://github.com/openlayers/openlayers/pull/16464
• Lazily initialize VectorStyleRenderer Worker by @M393 in https://github.com/openlayers/openlayers/pull/16460
• Remove IE11 only MSFullscreenChange event handling by @MoonE in https://github.com/openlayers/openlayers/pull/16471
• Templatize TileQueue by @MoonE in https://github.com/openlayers/openlayers/pull/16470
• Returning false from once-listener should stop event propagation by @MoonE in https://github.com/openlayers/openlayers/pull/16469
• Bump puppeteer from 23.10.1 to 23.10.4 by @dependabot in https://github.com/openlayers/openlayers/pull/16473
• Bump marked from 15.0.3 to 15.0.4 by @dependabot in https://github.com/openlayers/openlayers/pull/16474

New Contributors

• @rwd made their first contribution in https://github.com/openlayers/openlayers/pull/16458
• @edsonmsj made their first contribution in https://github.com/openlayers/openlayers/pull/16468
• @MelkorCC made their first contribution in https://github.com/openlayers/openlayers/pull/16488
• @bilskip made their first contribution in https://github.com/openlayers/openlayers/pull/16522
• @viktorijasolovjova made their first contribution in https://github.com/openlayers/openlayers/pull/16506
• @jcphill made their first contribution in https://github.com/openlayers/openlayers/pull/16490
• @geographika made their first contribution in https://github.com/openlayers/openlayers/pull/16591

Full Changelog: https://github.com/openlayers/openlayers/compare/v10.3.1...v10.4.0