Package ca.spatial.reportwriter

Class MapLayoutReport.Scalebar

java.lang.Object
ca.spatial.reportwriter.MapLayoutReport.MapElement
ca.spatial.reportwriter.MapLayoutReport.Scalebar
Enclosing class:
MapLayoutReport
public class MapLayoutReport.Scalebar extends MapLayoutReport.MapElement
The scalebar element will a scalebar for the given mapper. This routine depends on the correct map units being set in the mapper.

  • Method Details

    • title

      public MapLayoutReport.Scalebar title​(String title)
      A title for the scale bar
      Parameters:
      title - the title to show on the scale bar

    • major

      public MapLayoutReport.Scalebar major​(int major)
      The major divisions of the scale bar
      Parameters:
      major - the number of major divisions to show

    • minor

      public MapLayoutReport.Scalebar minor​(int minor)
      The minor divisions of the scale bar
      Parameters:
      minor - the number of minor divisions to show

    • showRatio

      public MapLayoutReport.Scalebar showRatio​(boolean scale)
      Show the numeric ratio of the map scale
      Parameters:
      scale - true if the ratio should be shown

    • units

      public MapLayoutReport.Scalebar units​(int scaleunits)
      Set the units to use in calculating and displaying the scale. The units may be one of MapLayoutReport.KM, MapLayoutReport.MILES. The default value is MapLayoutReport.KM
      Parameters:
      scaleunits - the units used for calculating scale