Fill (Groovy Documentation)

geoscript.style.Fill

A Symbolizer for area/polygonal geometries. It consists of a color and an opacity. You can create a Fill from a color and opacity:
```
 def fill = new Fill('#ff0000', 0.5)
 
```
Or from named parameters:
```
 def fill = new Fill(color: '#ff0000', opacity: 0.25)
 
```
Authors:
Jared Erickson

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

Properties Summary

Properties
Type	Name and description
`private Expression`	`color` The Color (#ff0000, red, [0,0.,255])
`private Hatch`	`hatch` The Hatch
`private Icon`	`icon` The Icon
`private Expression`	`opacity` The opacity (1.0 = opaque to 0.0 = transparent)

Constructor Summary

Constructors
Constructor and description
`Fill (Map map)` Create a new Fill.
`Fill (java.lang.Object color, java.lang.Object opacity)` Create a new Fill.
`Fill ()`

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
	`protected Fill`	`createFill()` Create the GeoTools Fill object Returns: A GeoTools Fill
	`Fill`	`hatch(java.lang.String name, Stroke stroke, java.lang.Object size)` Compose this Fill with a Hatch pattern.
	`Fill`	`hatch(java.lang.String name, Fill fill, Stroke stroke, java.lang.Object size)` Compose this Fill with a Hatch pattern that has a Fill and Stroke.
	`Fill`	`hatch(java.lang.String name, Fill fill, java.lang.Object size)` Compose this Fill with a Hatch pattern that has a Fill but no Stroke
	`Fill`	`icon(java.lang.Object url, java.lang.String format)` Compose this Fill as an Icon.
	`protected void`	`prepare(Rule rule)` Prepare the GeoTools Rule by applying this Symbolizer Parameters: `rule` - The GeoTools Rule
	`Fill`	`random(Map params)` Add randomized fill.
	`void`	`setColor(java.lang.Object color)` Set the color Parameters: `color` - The color (#ffffff, red)
	`void`	`setOpacity(java.lang.Object opacity)` Set the opacity Parameters: `opacity` - The opacity
	`java.lang.String`	`toString()` The string representation Returns: 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
  - private Expression color
    
    The Color (#ff0000, red, [0,0.,255])
  - private Hatch hatch
    
    The Hatch
  - private Icon icon
    
    The Icon
  - private Expression opacity
    
    The opacity (1.0 = opaque to 0.0 = transparent)
- Constructor Detail
  - Fill(Map map)
    
    Create a new Fill.
```
 def f = new Fill(color: '#ff0000', opacity: 0.25)
 
```
    Parameters:
    map - A Map of named parameters.
  - Fill(java.lang.Object color, java.lang.Object opacity)
    
    Create a new Fill.
```
 def f = new Fill('#ff0000', 0.5)
 def f = new Fill('red', 0.5)
 def f = new Fill([255,0,0], 0.5)
 
```
    Parameters:
    color - The Color
    opacity - The opacity (1 opaque to 0 transparent)
  - Fill()
- Method Detail
  - @java.lang.OverrideOverride protected void apply(Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - protected Fill createFill()
    
    Create the GeoTools Fill object
    Returns:
    A GeoTools Fill
  - Fill hatch(java.lang.String name, Stroke stroke, java.lang.Object size)
    
    Compose this Fill with a Hatch pattern.
```
 def f = new Fill().hatch('slash')
 
```
    Parameters:
    name - The name of the hatch pattern
    stroke - The Stroke
    size - The size
    Returns:
    This Fill
  - Fill hatch(java.lang.String name, Fill fill, Stroke stroke, java.lang.Object size)
    
    Compose this Fill with a Hatch pattern that has a Fill and Stroke.
```
 def f = new Fill().hatch('slash', new Fill("white"), new Stroke("blue",0.1), 8)
 
```
    Parameters:
    name - The name of the hatch pattern
    fill - The Fill
    stroke - The Stroke
    size - The size
    Returns:
    This Fill
  - Fill hatch(java.lang.String name, Fill fill, java.lang.Object size)
    
    Compose this Fill with a Hatch pattern that has a Fill but no Stroke
```
 def f = new Fill().hatch('slash', new Fill("wheat"), 8)
 
```
    Parameters:
    name - The name of the hatch pattern
    fill - The Fill
    size - The size
    Returns:
    This Fill
  - Fill icon(java.lang.Object url, java.lang.String format)
    
    Compose this Fill as an Icon.
```
 def f = new Fill().icon('icon.png','image/png')
 
```
    Parameters:
    url - The URL or File of the image
    format - The mime type of the image.
    Returns:
    This Fill
  - @java.lang.OverrideOverride protected void prepare(Rule rule)
    
    Prepare the GeoTools Rule by applying this Symbolizer
    Parameters:
    rule - The GeoTools Rule
  - Fill random(Map params)
    
    Add randomized fill. See http://osgeo-org.1560.x6.nabble.com/Randomized-fill-landed-on-trunk-td5081889.html for more details.
    Parameters:
    params - Named parameters may include:
    
    random: none, free, grid
    
    seed: The seed generator value (defaults to 0)
    
    symbolCount: The number of symbols (defaults to 16)
    
    tileSize: The size of the square area (defaults to 256)
    
    rotation: Whether to rotate symbols (none or free)
    Returns:
    This Fill
  - void setColor(java.lang.Object color)
    
    Set the color
    Parameters:
    color - The color (#ffffff, red)
  - void setOpacity(java.lang.Object opacity)
    
    Set the opacity
    Parameters:
    opacity - The opacity
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Fill

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private Expression color

private Hatch hatch

private Icon icon

private Expression opacity

Constructor Detail

Fill(Map map)

Fill(java.lang.Object color, java.lang.Object opacity)

Fill()

Method Detail

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

protected Fill createFill()

Fill hatch(java.lang.String name, Stroke stroke, java.lang.Object size)

Fill hatch(java.lang.String name, Fill fill, Stroke stroke, java.lang.Object size)

Fill hatch(java.lang.String name, Fill fill, java.lang.Object size)

Fill icon(java.lang.Object url, java.lang.String format)

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

Fill random(Map params)

void setColor(java.lang.Object color)

void setOpacity(java.lang.Object opacity)

java.lang.String toString()