Package ca.spatial.reportwriter

Class MapLayoutReport.Legend

java.lang.Object

ca.spatial.reportwriter.MapLayoutReport.MapElement

ca.spatial.reportwriter.MapLayoutReport.Legend

Enclosing class:

MapLayoutReport

public class MapLayoutReport.Legend
extends MapLayoutReport.MapElement

The legend element will render the map legend for the given LayerList.

Method Summary

Modifier and Type	Method	Description
MapLayoutReport.MapElement	inset(double inset)	Set the inset for this element.
MapLayoutReport.MapElement	margin(double margin)	Set the margin for this element.
MapLayoutReport.MapElement	wrap(int mode)	Specify what happens if a part of the legend exceeds the height of the available area.

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

background, bookmark, contentHeight, contentWidth, getBackground, getHeight, getWidth, hidden, 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

margin

public MapLayoutReport.MapElement margin(double margin)

Description copied from class: MapLayoutReport.MapElement

Set the margin for this element. The margin will be applied equally on all sides outside of the neatline.

Overrides:

margin in class MapLayoutReport.MapElement

inset

public MapLayoutReport.MapElement inset(double inset)

Description copied from class: MapLayoutReport.MapElement

Set the inset for this element. The inset will be applied equally on all sides inside of the neatline.

Overrides:

inset in class MapLayoutReport.MapElement

wrap

public MapLayoutReport.MapElement wrap(int mode)

Specify what happens if a part of the legend exceeds the height of the available area.

• 0 - item is drawn off the bottom of the area
• 1 - item is started on the next column