ScaleBarItem (Groovy Documentation)

geoscript.carto.ScaleBarItem

```
class ScaleBarItem
extends Item
```
Adds scale bar to a cartographic document.
Authors:
Jared Erickson

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`ScaleBarItem.ScaleBarInfo`
`static enum`	`ScaleBarItem.Units`

Properties Summary

Properties
Type	Name and description
`java.awt.Color`	`barStrokeColor`
`float`	`barStrokeWidth`
`int`	`border`
`java.awt.Color`	`fillColor`
`java.awt.Font`	`font`
`Map`	`map`
`java.awt.Color`	`strokeColor`
`float`	`strokeWidth`
`java.awt.Color`	`textColor`
`ScaleBarItem.Units`	`units`

Constructor Summary

Constructors
Constructor and description
`ScaleBarItem(int x, int y, int width, int height)` Create a scale bar from the top left with the given width and height.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`ScaleBarItem`	`barStrokeColor(java.awt.Color strokeColor)` Set the bar stroke Color
	`ScaleBarItem`	`barStrokeWidth(float strokeWidth)` Set the bar stroke width
	`ScaleBarItem`	`border(int border)` Set the border padding
	`ScaleBarItem.ScaleBarInfo`	`calculateScaleBarInfo()` Calculate the scale bar information
	`ScaleBarItem`	`fillColor(java.awt.Color fillColor)` Set the fill Color
	`ScaleBarItem`	`font(java.awt.Font font)` Set the Font
	`ScaleBarItem`	`map(Map map)` Set the Map to use when calculating the map scale
	`ScaleBarItem`	`strokeColor(java.awt.Color strokeColor)` Set stroke Color
	`ScaleBarItem`	`strokeWidth(float strokeWidth)` Set the stroke width
	`ScaleBarItem`	`textColor(java.awt.Color color)` Set the text Color
	`ScaleBarItem`	`units(ScaleBarItem.Units units)` Set the Units (US or METRIC) to use

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Item`	`getRectangle`

- Property Detail
  - java.awt.Color barStrokeColor
  - float barStrokeWidth
  - int border
  - java.awt.Color fillColor
  - java.awt.Font font
  - Map map
  - java.awt.Color strokeColor
  - float strokeWidth
  - java.awt.Color textColor
  - ScaleBarItem.Units units
- Constructor Detail
  - ScaleBarItem(int x, int y, int width, int height)
    
    Create a scale bar from the top left with the given width and height.
    Parameters:
    x - The number of pixels from the left
    y - The number of pixels from the top
    width - The width in pixels
    height - The height in pixels
- Method Detail
  - ScaleBarItem barStrokeColor(java.awt.Color strokeColor)
    
    Set the bar stroke Color
    Parameters:
    strokeColor - The bar stroke Color
    Returns:
    The ScaleBarItem
  - ScaleBarItem barStrokeWidth(float strokeWidth)
    
    Set the bar stroke width
    Parameters:
    strokeWidth - The bar stroke width
    Returns:
    The ScaleBarItem
  - ScaleBarItem border(int border)
    
    Set the border padding
    Parameters:
    border - The border padding
    Returns:
    The ScaleBarItem
  - ScaleBarItem.ScaleBarInfo calculateScaleBarInfo()
    
    Calculate the scale bar information
    Returns:
    A ScaleBarInfo instance
  - ScaleBarItem fillColor(java.awt.Color fillColor)
    
    Set the fill Color
    Parameters:
    fillColor - The fill Color
    Returns:
    The ScaleBarItem
  - ScaleBarItem font(java.awt.Font font)
    
    Set the Font
    Parameters:
    font - The Font
    Returns:
    The ScaleBarItem
  - ScaleBarItem map(Map map)
    
    Set the Map to use when calculating the map scale
    Parameters:
    map - The Map
    Returns:
    The ScaleBarItem
  - ScaleBarItem strokeColor(java.awt.Color strokeColor)
    
    Set stroke Color
    Parameters:
    strokeColor - The stroke Color
    Returns:
    The ScaleBarItem
  - ScaleBarItem strokeWidth(float strokeWidth)
    
    Set the stroke width
    Parameters:
    strokeWidth - The stroke width
    Returns:
    The ScaleBarItem
  - ScaleBarItem textColor(java.awt.Color color)
    
    Set the text Color
    Parameters:
    color - The text Color
    Returns:
    The ScaleBarItem
  - ScaleBarItem units(ScaleBarItem.Units units)
    
    Set the Units (US or METRIC) to use
    Parameters:
    units - Units (US or METRIC)
    Returns:
    The ScaleBarItem

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class ScaleBarItem

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.awt.Color barStrokeColor

float barStrokeWidth

int border

java.awt.Color fillColor

java.awt.Font font

Map map

java.awt.Color strokeColor

float strokeWidth

java.awt.Color textColor

ScaleBarItem.Units units

Constructor Detail

ScaleBarItem(int x, int y, int width, int height)

Method Detail

ScaleBarItem barStrokeColor(java.awt.Color strokeColor)

ScaleBarItem barStrokeWidth(float strokeWidth)

ScaleBarItem border(int border)

ScaleBarItem.ScaleBarInfo calculateScaleBarInfo()

ScaleBarItem fillColor(java.awt.Color fillColor)

ScaleBarItem font(java.awt.Font font)

ScaleBarItem map(Map map)

ScaleBarItem strokeColor(java.awt.Color strokeColor)

ScaleBarItem strokeWidth(float strokeWidth)

ScaleBarItem textColor(java.awt.Color color)

ScaleBarItem units(ScaleBarItem.Units units)