Package ca.spatial.reportwriter

Class MapLayoutReport.Mapper

java.lang.Object

ca.spatial.reportwriter.MapLayoutReport.MapElement

ca.spatial.reportwriter.MapLayoutReport.Mapper

Enclosing class:

MapLayoutReport

public class MapLayoutReport.Mapper
extends MapLayoutReport.MapElement

The Mapper element will render the LayerList as a map.

Method Summary

Modifier and Type	Method	Description
MapLayoutReport.Mapper	alpha(double alpha)	Set an alpha that will be used when compositing raster layers
MapLayoutReport.Mapper	collapse(boolean state)	Collapse mode controls if the map layers are all drawn in to a single layer (true) or in to individual layers (false).
MapLayoutReport.Mapper	dpi(int units)	Set the resolution to be used if vector mode is off.
MapLayoutReport.Mapper	extent(double x, double y, double width, double height)	Set the map extent.
MapLayoutReport.Mapper	extent(Extent2D extent)	Set the map extent.
MapLayoutReport.MapElement	quality(float quality)	Set the quality for raster image compression.
double	realScale()	Calculate the actual map scale for this map
MapLayoutReport.Mapper	scale(double scale)	Set the map scale.
MapLayoutReport.Mapper	units(int mapunits)	Specify the units that the map data is digitized in.
MapLayoutReport.Mapper	vector(boolean state)	Set if the map should be rendered in vector mode or image mode.

Methods inherited from class ca.spatial.reportwriter.MapLayoutReport.MapElement

background, bookmark, contentHeight, contentWidth, getBackground, getHeight, getWidth, hidden, inset, margin, neatline, p, r, simplistHeight, simplistWidth, subtype, top, visible, zoom

Methods inherited from class java.lang.Object

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

Method Details

units

public MapLayoutReport.Mapper units(int mapunits)

Specify the units that the map data is digitized in. This is required so that correct scale factors can be determined.

dpi

public MapLayoutReport.Mapper dpi(int units)

Set the resolution to be used if vector mode is off. The map will be rendered in to an image with the specified resolution. The default value it 72dpi.

collapse

public MapLayoutReport.Mapper collapse(boolean state)

Collapse mode controls if the map layers are all drawn in to a single layer (true) or in to individual layers (false). The default value is false.

scale

public MapLayoutReport.Mapper scale(double scale)

Set the map scale. The map zommed from the centre of the map to meet this map scale.

extent

public MapLayoutReport.Mapper extent(double x,
 double y,
 double width,
 double height)

Set the map extent. This is the ground coordinates of the map that are visible in the mapping window.

extent

public MapLayoutReport.Mapper extent(Extent2D extent)

Set the map extent. This is the ground coordinates of the map that are visible in the mapping window.

alpha

public MapLayoutReport.Mapper alpha(double alpha)

Set an alpha that will be used when compositing raster layers

vector

public MapLayoutReport.Mapper vector(boolean state)

Set if the map should be rendered in vector mode or image mode. In some cases raster mode can result in a smaller map image.

quality

public MapLayoutReport.MapElement quality(float quality)

Set the quality for raster image compression. A value of 1 means no compression and allows transparancy. Any value less than 1 will disable transparancy and allow compression.

realScale

public double realScale()

Calculate the actual map scale for this map