Halo (Groovy Documentation)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

geoscript.style.Halo

class Halo
extends Symbolizer

A Symbolizer for label background. You can create a Halo from a Fill and radius:

 def halo = new Halo(new Fill("navy"), 2.5)

Or with named parameters:

 def halo = new Halo(fill: new Fill("navy"), radius: 2.5)

Authors:: Jared Erickson

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

Properties Summary

Properties
Type	Name and description
`Fill`	`fill` The Fill
`Expression`	`radius` The radius

Constructor Summary

Constructors
Constructor and description
`Halo (Map map)` Create a new Halo with named parameters.
`Halo (Fill fill, java.lang.Object radius)` Create a new Halo with a Fill and radius.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`apply(Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer
	`protected void`	`prepare(Rule rule)` Prepare the GeoTools Rule by applying this Symbolizer
	`void`	`setRadius(java.lang.Object radius)` Set the radius
	`java.lang.String`	`toString()` The string representation

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
  - Fill fill
    
    The Fill
  - Expression radius
    
    The radius
- Constructor Detail
  - Halo(Map map)
    
    Create a new Halo with named parameters.
```
 def halo = new Halo(fill: new Fill("navy"), radius: 2.5)
 
```
    Parameters:
    map - A Map of named parameters.
  - Halo(Fill fill, java.lang.Object radius)
    
    Create a new Halo with a Fill and radius.
```
 def halo = new Halo(new Fill("navy"), 2.5)
 
```
    Parameters:
    fill - The Fill
    radius - The radius
- Method Detail
  - @java.lang.Override protected void apply(Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - @java.lang.Override protected void prepare(Rule rule)
    
    Prepare the GeoTools Rule by applying this Symbolizer
    Parameters:
    rule - The GeoTools Rule
  - void setRadius(java.lang.Object radius)
    
    Set the radius
    Parameters:
    radius - The radius
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation