org.mapfish.print.map.geotools.grid

Class GridParam

java.lang.Object

org.mapfish.print.map.AbstractLayerParams

org.mapfish.print.map.geotools.grid.GridParam

public final class GridParam
extends AbstractLayerParams

Parameters relevant to creating Grid layers. CSOFF: VisibilityModifier

Field Summary

Fields

Modifier and Type	Field and Description
int[]	numberOfLines The x,y number of grid lines.
double[]	origin The x,y point of grid origin.
int	pointsInLine The number of points that will be in the grid line.
java.lang.Boolean	renderAsSvg Indicates if the layer is rendered as SVG.
double[]	spacing The x,y spacing between grid lines.
java.lang.String	style The style name of a style to apply to the features during rendering.

Fields inherited from class org.mapfish.print.map.AbstractLayerParams

name, opacity

Constructor Summary

Constructors

Constructor and Description
GridParam()

Method Summary

Methods

Modifier and Type	Method and Description
void	postConstruct() Initialize default values and validate that config is correct.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

spacing

public double[] spacing

The x,y spacing between grid lines.

Either spacing or numberOfLines

If spacing is defined then origin must also be defined

origin

public double[] origin

The x,y point of grid origin.

This is required if spacing is defined.

numberOfLines

public int[] numberOfLines

The x,y number of grid lines.

The x is the number of lines that run vertically along the page.

style

public java.lang.String style

The style name of a style to apply to the features during rendering. The style name must map to a style in the template or the configuration objects.

If no style is defined then the default grid style will be used.

The feature for the grid will have a line geometry and will have the following attributes:

• "rotation" -- the rotation for a label that is perpendicular to the line
• "label" -- The suggested text of the label
• "xDisplacement" -- The x-displacement of one of the labels (might be top or left) the unit is pixels.
• "yDisplacement" -- The y-displacement of one of the labels (might be top or left) the unit is pixels.

renderAsSvg

public java.lang.Boolean renderAsSvg

Indicates if the layer is rendered as SVG.

(will default to Configuration.defaultStyle).

pointsInLine

public int pointsInLine

The number of points that will be in the grid line. If the line will be curved (for certain projections) then the more points the smoother the curve.

The default number of points is .

Constructor Detail

GridParam

public GridParam()

Method Detail

postConstruct

public void postConstruct()

Initialize default values and validate that config is correct.