Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update dependency ol to ^10.4.0 #1176

Merged
merged 1 commit into from
Feb 4, 2025
Merged

Update dependency ol to ^10.4.0 #1176

merged 1 commit into from
Feb 4, 2025

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 3, 2025

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
ol (source) ^10.3.1 -> ^10.4.0 age adoption passing confidence

Release Notes

openlayers/openlayers (ol)

v10.4.0

Compare Source

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 [email protected] 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

New Contributors

Full Changelog: openlayers/openlayers@v10.3.1...v10.4.0

Configuration

📅 Schedule: Branch creation - "before 4am on the first day of the month" (UTC), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot requested a review from a team February 3, 2025 09:54
@codecov Codecov
Copy link

codecov bot commented Feb 3, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.12%. Comparing base (fe50b96) to head (3559bd0).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1176   +/-   ##
=======================================
  Coverage   89.12%   89.12%           
=======================================
  Files          58       58           
  Lines        3422     3422           
  Branches      448      448           
=======================================
  Hits         3050     3050           
  Misses        372      372

@renovate renovate bot force-pushed the renovate/ol-10.x branch from a5aa855 to b859dd4 Compare February 3, 2025 10:01
@renovate renovate bot force-pushed the renovate/ol-10.x branch from b859dd4 to 3559bd0 Compare February 3, 2025 10:14
@kdeininger kdeininger merged commit a3ddb7d into main Feb 4, 2025
16 checks passed
@kdeininger kdeininger deleted the renovate/ol-10.x branch February 4, 2025 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kdeininger kdeininger kdeininger approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@kdeininger