Clean up and document event propagation properties #5880
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also documents events' target, sourceTarget, propagatedFrom and layer properties. Fixes #4510.
IvanSanchez
requested changes
Oct 27, 2017
src/core/Events.leafdoc
Outdated
| For propagated events, the last object that propagated the event to its | ||
| event parent. | ||
| @property layer: Object | ||
| **Deprecated.** The same as `propagetedFrom`. |
There was a problem hiding this comment.
Typo here: propageted vs propagated
There was a problem hiding this comment.
Nice catch 👍, fixed now.
IvanSanchez
approved these changes
Oct 27, 2017
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I had somehow missed #4510 and was a bit surprised to find out about this undocumented hack to get
FeatureGroupto work.Thinking about it, I think the approach in itself is sane, but the real problem lies in the naming of the event property -
layeris very specific toFeatureGroup's utilization of the property.On the other hand, there's probably a lot of code out there that use this property, so I'm going for deprecating this property, although actually removing it is not something we need to do soon.
Instead, I added two properties:
sourceTarget- this is the original target of the event, the object it was first fire on before any propagation occuredpropagatedFrom- this is exactly the same as the currentlayer; that is, the previous object in the chain of object propagating the event (to be honest, I don't feel 100% about the name of this property, so feel free to suggest a better one)Ideally, we should have made this analog to the DOM's
targetandcurrentTarget, but we already use the propertytargetwith the same semantic as the DOM'scurrentTarget, so that will unfortunately not work.