add documentation for 'change:extent' event #13
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
jkissel
requested changes
Jan 29, 2024
src/cadenza.js
Outdated
| @@ -204,6 +204,8 @@ export class CadenzaClient { | |||
| * view, each row includes the geometry of the selected object as the last value. | |||
| * <p> | |||
| * See also: [JSON Representation of Cadenza Object Data](../index.html#md:json-representation-of-cadenza-object-data) | |||
| * @fires `change:extent` - When the map extent is changed a POST message 'change:extent' is fired. | |||
| * The event details contain the new {@link Extent} of the map (transformed to EPSG:4326). | |||
There was a problem hiding this comment.
On Friday, I improved the way how events are documented: 6020ae8
Goals:
- Remove the duplication of the documentation if the event is fired from multiple methods (like in your case).
- Document the type of the event detail.
Proposal for your event:
/** @typedef {CadenzaEvent<'change:extent', {extent: Extent}>} CadenzaChangeExtentEvent - When the user moved the map. The extent is transformed according to the `useMapSrs` option. */(Sry, I should've informed you about the change. I hope I didn't cause too much trouble.)
| @@ -205,6 +205,19 @@ const unsubscribe = cadenzaClient.on('editGeometry:ok', (event) => ...); | |||
| unsubscribe(); | |||
| ``` | |||
|
|
|||
| ### Subscribe to map extent change | |||
|
|
|||
| Subscribe to `extent:change` event to be notified about map extent changes. The event details contain the new map extent (transformed to EPSG:4326): | |||
There was a problem hiding this comment.
It's change:extent. But if I look at the example - maybe it's not really necessary, because the event is documented in the api docs and we already have an example for subscribing to an event in TS. What do you think?
If you keep the example (and resolved the above comment), you should use the CadenzaChangeExtentEvent type.
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.
No description provided.