Label (Groovy Documentation)

geoscript.style.Label

A Symbolizer for labeling a geometry.
You can create a Label with a Field or a Field name:
```
 def label = new Label("STATE_ABBR")
 
```
Or with named parameters:
```
 def label = new Label(property: "name", font: new Font(weight: "bold")))
 
```
Authors:
Jared Erickson

Inherited fields
Fields inherited from class	Fields
`class Symbolizer`	`filterFactory, styleBuilder, styleFactory, styleOptions`

Properties Summary

Properties
Type	Name and description
`private Fill`	`fill` The Fill
`private java.awt.Font`	`font` The Font
`private Halo`	`halo` The Halo
`private java.lang.Object`	`placement` The Point or Line Placement
`private Expression`	`priority` The priority
`private Expression`	`property` The property can be a Field, String, or Function
`private Shape`	`shape` The Shape

Constructor Summary

Constructors
Constructor and description
`Label (java.lang.Object property)` Create a new Label with a property which is a field or attribute with which to generate labels form.
`Label (Map map)` Create a new Label with named parameters.
`Label ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`apply(Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer Parameters: `sym` - The GeoTools Symbolizer
	`Label`	`autoWrap(int length)` Set the auto wrap length.
	`Label`	`characterSpacing(int spacing)` Set the spacing between characters Parameters: `spacing` - The spacing Returns: This Label
	`Label`	`conflictResolution(boolean bool)` Disable label conflict resolution or not.
	`Label`	`fill(Fill fill)` Set how the Label will be filled.
	`Label`	`font(java.lang.Object font)` Set the Font Parameters: `font` - A GeoScript Font or an object convertable to a Font Returns: This Label
	`Label`	`forceLeftToRight(boolean bool)` Disable label flipping making labels always follow natural orientation of the line or not.
	`Label`	`goodnessOfFit(float goodness)` Set the goodness of fit parameter (a number between 0 and 1) Parameters: `goodness` - The goodness of fit parameter (a number between 0 and 1) Returns: This Label
	`Label`	`graphicResize(java.lang.String mode, int margin)` Set the graphic resize mode (none, proportional, stretch) and margin.
	`Label`	`halo(Fill fill, java.lang.Object radius)` Add a Halo to this Label Parameters: `fill` - The Fill `radius` - The radius Returns: This Label
	`Label`	`labelAllGroup(boolean bool)` Make all line segments are labeled instead of just the longest Parameters: `bool` - Whether to label all or just the longest Returns: This label
	`Label`	`labelObstacle(boolean bol)` Set whether to use the Label as an obstacle or not Parameters: `bol` - Whether to use the Label as an obstacle Returns: This Label
	`Label`	`linear(java.lang.Object offset, java.lang.Object gap, java.lang.Object igap, boolean align, boolean follow, boolean group, java.lang.Object displacement, java.lang.Object repeat)` Set the Line Placement for this Label Parameters: `offset` - The perpendicular offset `gap` - The gap `igap` - The initial gap `align` - Whether to align or not `follow` - Whether to follow lines or not (true or false) `group` - Whether to group or not `displacement` - The maximum displacement distance `repeat` - The repeat distance Returns: This Label
	`Label`	`linear(Map parameters)` Set the Line Placement for this Label Parameters: `parameters` - A Map of named parameters (offset, gap, igap, align, follow, group, displacement, repeat) Returns: This label
	`Label`	`maxAngleDelta(float maxAngleDelta)` Set the max angle delta Parameters: `maxAngleDelta` - The max angle delta Returns: This Label
	`Label`	`maxDisplacement(double maxDisplacement)` Set the max displacement Parameters: `maxDisplacement` - The max displacement Returns: This Label
	`Label`	`point(List anchor, List displace, java.lang.Object rotate)` Set the Point Placement for this Label Parameters: `anchor` - The anchor `displace` - The displacement `rotate` - The rotation Returns: This Label
	`Label`	`point(Map parameters)` Set the Point Placement for this Label Parameters: `parameters` - A Map of named parameters (anchor, displace, and rotate) Returns: This Label
	`Label`	`polygonAlign(java.lang.String value)` Set the polygon align option (manual, ortho, mbr) Parameters: `value` - The polygon align option (manual, ortho, mbr) Returns: This Label
	`protected void`	`prepare(Rule rule)` Prepare the GeoTools Rule by applying this Symbolizer Parameters: `rule` - The GeoTools Rule
	`Label`	`priority(java.lang.Object priority)` Set the priority Parameters: `priority` - The priority Returns: This Label
	`void`	`setProperty(java.lang.Object property)` Set the Label's Property which can be a String, a Field, or a Function Parameters: `property` - The Label's Property
	`Label`	`shape(Shape shape)` Set the Shape surrounding the Label Parameters: `shape` - The Shape Returns: This Label
	`Label`	`spaceAround(float distance)` Set the space around a Label.
	`Label`	`strikethrough(boolean shouldStrikeThrough)` Set whether the Label should strike through the text or not Parameters: `shouldStrikeThrough` - Whether the label text should be underlined Returns: This label
	`java.lang.String`	`toString()` The string representation Returns: The string representation
	`Label`	`underline(boolean shouldUnderline)` Set whether the Label should underline the text or not Parameters: `shouldUnderline` - Whether the label text should be underlined Returns: This label
	`Label`	`wordSpacing(int spacing)` Set the spacing between words Parameters: `spacing` - The spacing Returns: This Label

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Symbolizer`	`and, apply, asSLD, asSLD, buildString, composite, createGeoToolsSymbolizer, getDefault, getDefault, getGeoToolsSymbolizers, getGtStyle, getSld, plus, prepare, prepare, range, range, sortBy, sortBy, where, zindex`

- Property Detail
  - private Fill fill
    
    The Fill
  - private java.awt.Font font
    
    The Font
  - private Halo halo
    
    The Halo
  - private java.lang.Object placement
    
    The Point or Line Placement
  - private Expression priority
    
    The priority
  - private Expression property
    
    The property can be a Field, String, or Function
  - private Shape shape
    
    The Shape
- Constructor Detail
  - Label(java.lang.Object property)
    
    Create a new Label with a property which is a field or attribute with which to generate labels form.
```
 def label = new Label("STATE_ABBR")
 
```
    Parameters:
    property - The field or attribute
  - Label(Map map)
    
    Create a new Label with named parameters.
```
 def label = new Label(property: "name", font: new Font(weight: "bold")))
 
```
    Parameters:
    map - A Map of named parameters.
  - Label()
- Method Detail
  - @java.lang.OverrideOverride protected void apply(Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - Label autoWrap(int length)
    
    Set the auto wrap length. Labels longer than this value will be wrapped.
    Parameters:
    length - The auto wrap length
    Returns:
    This Label
  - Label characterSpacing(int spacing)
    
    Set the spacing between characters
    Parameters:
    spacing - The spacing
    Returns:
    This Label
  - Label conflictResolution(boolean bool)
    
    Disable label conflict resolution or not.
    Parameters:
    bool - Whether disable conflict resolution or not
    Returns:
    This Label
  - Label fill(Fill fill)
    
    Set how the Label will be filled.
    Parameters:
    fill - The Fill
    Returns:
    This Label
  - Label font(java.lang.Object font)
    
    Set the Font
    Parameters:
    font - A GeoScript Font or an object convertable to a Font
    Returns:
    This Label
  - Label forceLeftToRight(boolean bool)
    
    Disable label flipping making labels always follow natural orientation of the line or not.
    Parameters:
    bool - Whether to disable label flipping
    Returns:
    This Label
  - Label goodnessOfFit(float goodness)
    
    Set the goodness of fit parameter (a number between 0 and 1)
    Parameters:
    goodness - The goodness of fit parameter (a number between 0 and 1)
    Returns:
    This Label
  - Label graphicResize(java.lang.String mode, int margin)
    
    Set the graphic resize mode (none, proportional, stretch) and margin.
    Parameters:
    mode - The graphic resize mode
    mode - The graphic resize mode
    Returns:
    This Label
  - Label halo(Fill fill, java.lang.Object radius)
    
    Add a Halo to this Label
    Parameters:
    fill - The Fill
    radius - The radius
    Returns:
    This Label
  - Label labelAllGroup(boolean bool)
    
    Make all line segments are labeled instead of just the longest
    Parameters:
    bool - Whether to label all or just the longest
    Returns:
    This label
  - Label labelObstacle(boolean bol)
    
    Set whether to use the Label as an obstacle or not
    Parameters:
    bol - Whether to use the Label as an obstacle
    Returns:
    This Label
  - Label linear(java.lang.Object offset, java.lang.Object gap, java.lang.Object igap, boolean align, boolean follow, boolean group, java.lang.Object displacement, java.lang.Object repeat)
    
    Set the Line Placement for this Label
    Parameters:
    offset - The perpendicular offset
    gap - The gap
    igap - The initial gap
    align - Whether to align or not
    follow - Whether to follow lines or not (true or false)
    group - Whether to group or not
    displacement - The maximum displacement distance
    repeat - The repeat distance
    Returns:
    This Label
  - Label linear(Map parameters)
    
    Set the Line Placement for this Label
    Parameters:
    parameters - A Map of named parameters (offset, gap, igap, align, follow, group, displacement, repeat)
    Returns:
    This label
  - Label maxAngleDelta(float maxAngleDelta)
    
    Set the max angle delta
    Parameters:
    maxAngleDelta - The max angle delta
    Returns:
    This Label
  - Label maxDisplacement(double maxDisplacement)
    
    Set the max displacement
    Parameters:
    maxDisplacement - The max displacement
    Returns:
    This Label
  - Label point(List anchor, List displace, java.lang.Object rotate)
    
    Set the Point Placement for this Label
    Parameters:
    anchor - The anchor
    displace - The displacement
    rotate - The rotation
    Returns:
    This Label
  - Label point(Map parameters)
    
    Set the Point Placement for this Label
    Parameters:
    parameters - A Map of named parameters (anchor, displace, and rotate)
    Returns:
    This Label
  - Label polygonAlign(java.lang.String value)
    
    Set the polygon align option (manual, ortho, mbr)
    Parameters:
    value - The polygon align option (manual, ortho, mbr)
    Returns:
    This Label
  - @java.lang.OverrideOverride protected void prepare(Rule rule)
    
    Prepare the GeoTools Rule by applying this Symbolizer
    Parameters:
    rule - The GeoTools Rule
  - Label priority(java.lang.Object priority)
    
    Set the priority
    Parameters:
    priority - The priority
    Returns:
    This Label
  - void setProperty(java.lang.Object property)
    
    Set the Label's Property which can be a String, a Field, or a Function
    Parameters:
    property - The Label's Property
  - Label shape(Shape shape)
    
    Set the Shape surrounding the Label
    Parameters:
    shape - The Shape
    Returns:
    This Label
  - Label spaceAround(float distance)
    
    Set the space around a Label. A negative number will allow labels to overlap. A positive number will create more space between labels
    Parameters:
    distance - A negative or positive distance between labels
    Returns:
    This label
  - Label strikethrough(boolean shouldStrikeThrough)
    
    Set whether the Label should strike through the text or not
    Parameters:
    shouldStrikeThrough - Whether the label text should be underlined
    Returns:
    This label
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation
  - Label underline(boolean shouldUnderline)
    
    Set whether the Label should underline the text or not
    Parameters:
    shouldUnderline - Whether the label text should be underlined
    Returns:
    This label
  - Label wordSpacing(int spacing)
    
    Set the spacing between words
    Parameters:
    spacing - The spacing
    Returns:
    This Label

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Label

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private Fill fill

private java.awt.Font font

private Halo halo

private java.lang.Object placement

private Expression priority

private Expression property

private Shape shape

Constructor Detail

Label(java.lang.Object property)

Label(Map map)

Label()

Method Detail

@java.lang.OverrideOverride protected void apply(Symbolizer sym)

Label autoWrap(int length)

Label characterSpacing(int spacing)

Label conflictResolution(boolean bool)

Label fill(Fill fill)

Label font(java.lang.Object font)

Label forceLeftToRight(boolean bool)

Label goodnessOfFit(float goodness)

Label graphicResize(java.lang.String mode, int margin)

Label halo(Fill fill, java.lang.Object radius)

Label labelAllGroup(boolean bool)

Label labelObstacle(boolean bol)

Label linear(java.lang.Object offset, java.lang.Object gap, java.lang.Object igap, boolean align, boolean follow, boolean group, java.lang.Object displacement, java.lang.Object repeat)

Label linear(Map parameters)

Label maxAngleDelta(float maxAngleDelta)

Label maxDisplacement(double maxDisplacement)

Label point(List anchor, List displace, java.lang.Object rotate)

Label point(Map parameters)

Label polygonAlign(java.lang.String value)

@java.lang.OverrideOverride protected void prepare(Rule rule)

Label priority(java.lang.Object priority)

void setProperty(java.lang.Object property)

Label shape(Shape shape)

Label spaceAround(float distance)

Label strikethrough(boolean shouldStrikeThrough)

java.lang.String toString()

Label underline(boolean shouldUnderline)

Label wordSpacing(int spacing)