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
GridFontParam	font Configuration for the font of the grid labels.
java.lang.String	gridColor The color of the grid points or lines.
GridType	gridType The type of grid to render.
java.lang.String	haloColor The color of the halo around grid label text.
int	haloRadius The size of the halo around the Grid Labels.
int	indent The number of pixels to indent the grid labels from the end of the map.
java.lang.String	labelColor The color of the grid label text.
java.lang.String	labelFomat The formatting string used to format the label (for example "%1.2f %s").
java.lang.String	labelProjection The projection code to use for the labels.
java.lang.Boolean	longitudeFirst By default the normal axis order as specified in EPSG code will be used when parsing projections.
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 (if the gridType is LINES).
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

failOnError, name, opacity

Constructor Summary

Constructors

Constructor and Description
GridParam()

Method Summary

Methods

Modifier and Type	Method and Description
org.opengis.referencing.operation.MathTransform	calculateLabelTransform(org.opengis.referencing.crs.CoordinateReferenceSystem mapCrs) Determine which math transform to use when creating the coordinate of the label.
java.lang.String	calculateLabelUnit(org.opengis.referencing.crs.CoordinateReferenceSystem mapCrs) Determine which unit to use when creating grid labels.
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

gridType

public GridType gridType

The type of grid to render. By default it is LINES

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 default will depend if the type is point or line and will respect gridColor and haloColor and haloRadius. If gridType is GridType.POINTS then the style will be crosses with a haloRadius sized halo around the cross. If GridType.LINES then the style will be a dashed line with no halo.

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 gridType is LINES). If the line will be curved (for certain projections) then the more points the smoother the curve.

The default number of points is .

haloRadius

public int haloRadius

The size of the halo around the Grid Labels. The default is .

haloColor

public java.lang.String haloColor

The color of the halo around grid label text. The color is defined the same as colors in CSS. Default is white ()

labelColor

public java.lang.String labelColor

The color of the grid label text. Default is dark gray ()

gridColor

public java.lang.String gridColor

The color of the grid points or lines. Default is gray ()

font

public GridFontParam font

Configuration for the font of the grid labels. The default is the default system font.

indent

public int indent

The number of pixels to indent the grid labels from the end of the map. The default is .

labelProjection

public java.lang.String labelProjection

The projection code to use for the labels. The value should be the string authority:code form identifying the projection. By default it will be the same projection as the map.

labelFomat

public java.lang.String labelFomat

The formatting string used to format the label (for example "%1.2f %s"). By default the label is formatted according to the unit and label value.

longitudeFirst

public java.lang.Boolean longitudeFirst

By default the normal axis order as specified in EPSG code will be used when parsing projections. However the requestor can override this by explicitly declaring that longitude axis is first.

Constructor Detail

GridParam

public GridParam()

Method Detail

postConstruct

public void postConstruct()

Initialize default values and validate that config is correct.

calculateLabelUnit

public java.lang.String calculateLabelUnit(org.opengis.referencing.crs.CoordinateReferenceSystem mapCrs)

Determine which unit to use when creating grid labels.

Parameters:

mapCrs - the crs of the map, used if the labelProjection is not defined.

calculateLabelTransform

public org.opengis.referencing.operation.MathTransform calculateLabelTransform(org.opengis.referencing.crs.CoordinateReferenceSystem mapCrs)

Determine which math transform to use when creating the coordinate of the label.

Parameters:

mapCrs - the crs of the map, used if the labelProjection is not defined.