Skip to content

Map#on, once and off - support for multiple layers #4570

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
Merged
merged 25 commits into from
Aug 24, 2024
Merged

Map#on, once and off - support for multiple layers #4570

merged 25 commits into from
Aug 24, 2024

Conversation

pstaszek
Copy link
Contributor

@pstaszek pstaszek commented Aug 16, 2024 •
edited
Loading

Implements: #4279

This PR adds support for adding listener for multiple layers using Map#on and Map#once. It also adds support for removing listeners with Map#off function.

To remove listener in off function the user has to provide array of layerIds with the same content as when creating the listener. I chose this approach because it seems the simplest, there is no need to consider complex cases (i.e. remove only part of layers from listener).

I intentionally did not check the Mapbox GL JS implementation before I wrote my code. I did it after and to some degree it is similar, because it is the most obvious implementation. Is it ok, or should we try to find some other way to implement this feature?

Launch Checklist

  • Confirm your changes do not include backports from Mapbox projects (unless with compliant license) - if you are not sure about this, please ask!
  • Briefly describe the changes in this PR.
  • Link to related issues.
  • Include before/after visuals or gifs if this PR includes visual changes.
  • Write tests for all new functionality.
  • Document any changes to public APIs.
  • Post benchmark scores.
  • Add an entry to CHANGELOG.md under the ## main section.

pstaszek added 13 commits July 12, 2024 21:37
@pstaszek
add support for multiple layers in map.on
8a6bae8
@pstaszek
add unit tests
64c2db0
@pstaszek
update CHANGELOG.md
b377040
@pstaszek
update documentation
6b62620
@pstaszek
Merge branch 'main' of https://github.com/pstaszek/maplibre-gl-js int…
a38efb9 
…o issue-4279-map-on-multiple-layers
@pstaszek
delegated listeners with multiple layers instead of separate delegate…
461db4c 
…d listeners for each layer
@pstaszek
Merge branch 'main' of https://github.com/pstaszek/maplibre-gl-js int…
2b0e716 
…o issue-4279-map-on-multiple-layers
@pstaszek
fix: use only existing layers in queryRenderedFeatures
f1cf6c8
@pstaszek
add unit test of map#off layers comparison
c3920f5
@pstaszek
add missing semicolon
f606257
@pstaszek
Merge branch 'main' of https://github.com/pstaszek/maplibre-gl-js int…
e6be1fe 
…o issue-4279-map-on-multiple-layers
@pstaszek
update descriptions
013c057
@pstaszek
cleaning
5e411b1
@codecov-commenter
Copy link

codecov-commenter commented Aug 17, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 93.65079% with 4 lines in your changes missing coverage. Please review.

Project coverage is 87.72%. Comparing base (8a005bd) to head (a0b009b).
Report is 260 commits behind head on main.

Files with missing lines Patch % Lines
src/ui/map.ts 93.65% 2 Missing and 2 partials ⚠️
Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #4570      +/-   ##
==========================================
- Coverage   87.84%   87.72%   -0.12%     
==========================================
  Files         247      247              
  Lines       33574    33601      +27     
  Branches     2366     2391      +25     
==========================================
- Hits        29492    29476      -16     
- Misses       3116     3131      +15     
- Partials      966      994      +28

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@HarelM
Copy link
Collaborator

HarelM commented Aug 17, 2024

Can you check if the coverage is correct?
Otherwise, looks good.

@pstaszek
Copy link
Contributor Author

@HarelM I have bumped up the coverage with few additional tests.

HarelM
HarelM reviewed Aug 21, 2024
View reviewed changes
HarelM
HarelM reviewed Aug 21, 2024
View reviewed changes
HarelM
HarelM reviewed Aug 21, 2024
View reviewed changes
@pstaszek
Copy link
Contributor Author

I have some issue with registering once event, but I'm not sure if it is related to this PR. I will investigate it further tomorrow, or during the weekend.

@pstaszek
Copy link
Contributor Author

pstaszek commented Aug 23, 2024 •
edited
Loading

Ok - this is something unrelated to this PR.
I notice a bug, that it is not possible to deregister a listener added with once method with a layer - this is because removeDelegatedListener function looks for callback reference in this._delegatedListener, but once method is not saving it there.

HarelM
HarelM reviewed Aug 24, 2024
View reviewed changes
src/ui/map.ts Outdated

_removeDelegatedListener(type: string, layerIds: string[], listener: Listener) {
if (!this._delegatedListeners || !this._delegatedListeners[type]) {
return this;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure returning "this" is needed.
I would simply return void.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, done.

@HarelM
Copy link
Collaborator

HarelM commented Aug 24, 2024

Can you fix the build test please? Just update the size.

@pstaszek
Copy link
Contributor Author

Ofc, should I update this value: https://github.com/pstaszek/maplibre-gl-js/blob/1c30ee6ce8a9e37558ba0ea2c09b06fe428e7c89/test/build/min.test.ts#L39 ?

@HarelM
Copy link
Collaborator

HarelM commented Aug 24, 2024

Yes please.

@HarelM HarelM merged commit 2b847a3 into maplibre:main Aug 24, 2024
15 checks passed
@HarelM
Copy link
Collaborator

HarelM commented Aug 24, 2024

Thanks!!!

@pstaszek pstaszek deleted the issue-4279-map-on-multiple-layers branch August 24, 2024 18:44
@birkskyum birkskyum mentioned this pull request Sep 6, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@neodescis neodescis neodescis left review comments

@HarelM HarelM HarelM 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.
4 participants
@pstaszek @codecov-commenter @HarelM @neodescis
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy