org.geomajas.service

Interface LegendGraphicService

@Api(allMethods=true)
public interface LegendGraphicService

This service creates graphical symbols (typically icons) for use in a map legend. It should support most of the WMS GetLegendGraphicRequest parameters.

Since:

1.10.0

Author:

Jan De Moerloose, Oliver May

Method Summary

Methods

Modifier and Type	Method and Description
RenderedImage	getLegendGraphic(LegendGraphicMetadata legendMetadata) Get the graphical symbol based on the specified legend metadata.
RenderedImage	getLegendGraphics(List<LegendGraphicMetadata> legendMetadata) Get the graphical symbols based on the specified legend metadata.

Method Detail

getLegendGraphic

RenderedImage getLegendGraphic(LegendGraphicMetadata legendMetadata)
                               throws GeomajasException

Get the graphical symbol based on the specified legend metadata.

Parameters:

legendMetadata - the legend metadata

Returns:

a rendered image for producing the final image

Throws:

GeomajasException - thrown when invalid metadata are passed

getLegendGraphics

RenderedImage getLegendGraphics(List<LegendGraphicMetadata> legendMetadata)
                                throws GeomajasException

Get the graphical symbols based on the specified legend metadata.

Parameters:

legendMetadata - a list of legend metadata

Returns:

a rendered image that contains all legend symbols stacked vertically

Throws:

GeomajasException - thrown when invalid metadata are passed

Since:

1.13.0