Halo (Groovy Documentation)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

geoscript.style.Halo

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

Properties Summary

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

Constructor Summary

Constructors
Constructor and description
`Halo (java.util.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	Name and description
`protected void`	`apply(org.geotools.styling.Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer
`protected void`	`prepare(org.geotools.styling.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
`interface org.geotools.styling.Symbolizer`	org.geotools.styling.Symbolizer#accept(org.geotools.styling.StyleVisitor), org.geotools.styling.Symbolizer#setName(java.lang.String), org.geotools.styling.Symbolizer#hasOption(java.lang.String), org.geotools.styling.Symbolizer#getOptions(), org.geotools.styling.Symbolizer#getDescription(), org.geotools.styling.Symbolizer#getDescription(), org.geotools.styling.Symbolizer#setDescription(org.opengis.style.Description), org.geotools.styling.Symbolizer#getGeometry(), org.geotools.styling.Symbolizer#setGeometry(org.opengis.filter.expression.Expression), org.geotools.styling.Symbolizer#setUnitOfMeasure(javax.measure.unit.Unit), org.geotools.styling.Symbolizer#getGeometryPropertyName(), org.geotools.styling.Symbolizer#setGeometryPropertyName(java.lang.String), org.geotools.styling.Symbolizer#getName(), org.geotools.styling.Symbolizer#accept(org.opengis.style.StyleVisitor, java.lang.Object), org.geotools.styling.Symbolizer#getUnitOfMeasure()
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - Fill fill
    
    The Fill
  - Expression radius
    
    The radius
- Constructor Detail
  - Halo(java.util.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(org.geotools.styling.Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - @java.lang.Override protected void prepare(org.geotools.styling.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