geostyler-legend
v5.0.0
Published
A simple legend component for geostyler-stlye.
Downloads
2,840
Maintainers
Keywords
Readme
geostyler-legend
A simple legend component for geostyler-style.
Installation
npm i geostyler-legend
Usage
In order to render a legend, you construct a legend renderer like this:
const renderer = new LegendRenderer({
maxColumnWidth: 300,
maxColumnHeight: 300,
overflow: 'auto',
styles: [style],
size: [600, 300]
});
renderer.render(someElement);
The styles
property can contain a list of geostyler style objects that
each correspond to one legend rendered.
There are currently three modes. If constructed as above, the renderer will render multiple columns if needed, with a maximum width and height as specified. The columns will break on any legend element.
If the overflow
property is set to 'group'
, the columns will break on
legend boundaries only, leaving the rest of the column empty if starting
on a new legend.
If the maxColumnHeight
property is not set, the renderer will render just
one column with all the legends, thus ignoring the size parameter for the height.
Development
If you want to contribute, you can build the project like this:
git clone https://github.com/geostyler/geostyler-legend
cd geostyler-legend
npm i
and then
npm run build
in order to get a production build.
Funding & financial sponsorship
Maintenance and further development of this code can be funded through the GeoStyler Open Collective. All contributions and expenses can transparently be reviewed by anyone; you see what we use the donated money for. Thank you for any financial support you give the GeoStyler project 💞