NorthArrowItem (Groovy Documentation)

geoscript.carto.NorthArrowItem

```
class NorthArrowItem
extends Item
```
Add a north arrow to a cartographic document.
Authors:
Jared Erickson

Properties Summary

Properties
Type	Name and description
`boolean`	`drawText`
`java.awt.Color`	`fillColor1`
`java.awt.Color`	`fillColor2`
`java.awt.Font`	`font`
`java.awt.Color`	`strokeColor1`
`java.awt.Color`	`strokeColor2`
`float`	`strokeWidth`
`NorthArrowStyle`	`style`
`java.awt.Color`	`textColor`

Constructor Summary

Constructors
Constructor and description
`NorthArrowItem (int x, int y, int width, int height)` Create a north arrow from the top left with the given width and height.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`NorthArrowItem`	`drawText(boolean drawText)` Set whether to draw text or not
	`NorthArrowItem`	`fillColor1(java.awt.Color color)` Set the first fill color
	`NorthArrowItem`	`fillColor2(java.awt.Color color)` Set the second fill color
	`NorthArrowItem`	`font(java.awt.Font font)` Set the Font
	`NorthArrowItem`	`strokeColor1(java.awt.Color color)` Set the first stroke color
	`NorthArrowItem`	`strokeColor2(java.awt.Color color)` Set the second stroke Color
	`NorthArrowItem`	`strokeWidth(float strokeWidth)` Set the stroke width
	`NorthArrowItem`	`style(NorthArrowStyle northArrowStyle)` Set the NorthArrowStyle
	`NorthArrowItem`	`textColor(java.awt.Color textColor)` Set the text Color
	`java.lang.String`	`toString()`

Inherited Methods Summary

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

- Property Detail
  - boolean drawText
  - java.awt.Color fillColor1
  - java.awt.Color fillColor2
  - java.awt.Font font
  - java.awt.Color strokeColor1
  - java.awt.Color strokeColor2
  - float strokeWidth
  - NorthArrowStyle style
  - java.awt.Color textColor
- Constructor Detail
  - NorthArrowItem(int x, int y, int width, int height)
    
    Create a north arrow 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
  - NorthArrowItem drawText(boolean drawText)
    
    Set whether to draw text or not
    Parameters:
    drawText - Whether to draw text or not
    Returns:
    The NorthArrowItem
  - NorthArrowItem fillColor1(java.awt.Color color)
    
    Set the first fill color
    Parameters:
    color - The first fill color
    Returns:
    The NorthArrowItem
  - NorthArrowItem fillColor2(java.awt.Color color)
    
    Set the second fill color
    Parameters:
    color - The second fill Color
    Returns:
    The NorthArrowItem
  - NorthArrowItem font(java.awt.Font font)
    
    Set the Font
    Parameters:
    font - The Font
    Returns:
    The NorthArrowItem
  - NorthArrowItem strokeColor1(java.awt.Color color)
    
    Set the first stroke color
    Parameters:
    color - The first stroke color
    Returns:
    The NorthArrowItem
  - NorthArrowItem strokeColor2(java.awt.Color color)
    
    Set the second stroke Color
    Parameters:
    color - The second stroke Color
    Returns:
    The NorthArrowItem
  - NorthArrowItem strokeWidth(float strokeWidth)
    
    Set the stroke width
    Parameters:
    strokeWidth - The stroke width
    Returns:
    The NorthArrowItem
  - NorthArrowItem style(NorthArrowStyle northArrowStyle)
    
    Set the NorthArrowStyle
    Parameters:
    northArrowStyle - The NorthArrowStyle
    Returns:
    The NorthArrowItem
  - NorthArrowItem textColor(java.awt.Color textColor)
    
    Set the text Color
    Parameters:
    textColor - The text color
    Returns:
    The NorthArrowItem
  - @java.lang.Override java.lang.String toString()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class NorthArrowItem

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

boolean drawText

java.awt.Color fillColor1

java.awt.Color fillColor2

java.awt.Font font

java.awt.Color strokeColor1

java.awt.Color strokeColor2

float strokeWidth

NorthArrowStyle style

java.awt.Color textColor

Constructor Detail

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

Method Detail

NorthArrowItem drawText(boolean drawText)

NorthArrowItem fillColor1(java.awt.Color color)

NorthArrowItem fillColor2(java.awt.Color color)

NorthArrowItem font(java.awt.Font font)

NorthArrowItem strokeColor1(java.awt.Color color)

NorthArrowItem strokeColor2(java.awt.Color color)

NorthArrowItem strokeWidth(float strokeWidth)

NorthArrowItem style(NorthArrowStyle northArrowStyle)

NorthArrowItem textColor(java.awt.Color textColor)

@java.lang.Override java.lang.String toString()