Add legend package to generate legends from WMS and WMTS layers #19
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
ronitjadhav
force-pushed
the
get-legend
branch
from
713b6e0 to
7ebe068
Compare
jahow
approved these changes
Dec 16, 2024
packages/legend/README.md
Outdated
| }); | ||
| ``` | ||
|
|
||
| ## API Documentation |
There was a problem hiding this comment.
The API documentation should be written in the code as jsdoc annotations; there's an automatic website generated from it :) you can try it using npm run docs:dev
There was a problem hiding this comment.
Should I remove the API documentation section from here? I kept it because it might be visible on the package page on npmjs.com
There was a problem hiding this comment.
Hmm, I think you can remove it and put a link to the online documentation. Otherwise we'll have to maintain it manually and it might become misleading/wrong in the future.
ronitjadhav
force-pushed
the
get-legend
branch
from
1685ec9 to
01b2a89
Compare
|
Good job 🙂 |
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.
Description
This pull request introduces a new package
@geospatial-sdk/legendthat provides functionality for generating map layer legends. The changes include adding the core functionality, tests, configuration files, and necessary exports.Key changes include:
Core Functionality:
createLegendFromLayerfunction to generate legends for WMS and WMTS layers infrom-layer.ts. This includes handling different configurations and error cases.Testing:
createLegendFromLayerinfrom-layer.test.tsto ensure correct functionality and error handling.