org.geomajas.service.legend

Interface LegendGraphicMetadata

All Known Implementing Classes:

DefaultLegendGraphicMetadata

@Api(allMethods=true)
public interface LegendGraphicMetadata

Metadata for creating a legend graphic.

Since:

1.10.0

Author:

Jan De Moerloose

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HEIGHT Default height of the legend graphic.
static int	DEFAULT_WIDTH Default width of the legend graphic.

Method Summary

Methods

Modifier and Type	Method and Description
int	getHeight() Get the suggested height of the graphic, optional.
String	getLayerId() Get layer id, optional.
org.geomajas.sld.NamedStyleInfo	getNamedStyle() Get the named style, optional.
org.geomajas.sld.RuleInfo	getRule() Get the rule, optional.
double	getScale() Get the scale, optional.
org.geomajas.sld.UserStyleInfo	getUserStyle() Get the user style, optional.
int	getWidth() Get the suggested width of the graphic, optional.

Field Detail

DEFAULT_WIDTH

static final int DEFAULT_WIDTH

Default width of the legend graphic.

See Also:

Constant Field Values

DEFAULT_HEIGHT

static final int DEFAULT_HEIGHT

Default height of the legend graphic.

See Also:

Constant Field Values

Method Detail

getLayerId

String getLayerId()

Get layer id, optional.

Returns:

layer id

getUserStyle

org.geomajas.sld.UserStyleInfo getUserStyle()

Get the user style, optional.

Returns:

user style

getNamedStyle

org.geomajas.sld.NamedStyleInfo getNamedStyle()

Get the named style, optional.

Returns:

named style

getRule

org.geomajas.sld.RuleInfo getRule()

Get the rule, optional.

Returns:

the rule

getScale

double getScale()

Get the scale, optional. This scale will be used to determine the applicable rules.

Returns:

the scale

getWidth

int getWidth()

Get the suggested width of the graphic, optional.

Returns:

the width

getHeight

int getHeight()

Get the suggested height of the graphic, optional.

Returns:

the height