Hatch (Groovy Documentation)

geoscript.style.Hatch

class Hatch
extends Symbolizer

A Symbolizer that repeats a pattern. A hatch can be applied to linear and area geometries.

You can create a Hatch by specifying the name, Stroke, and size:

 def hatch = new Hatch("times", new Stroke("wheat", 1.2, [5,2], "square", "bevel"), 12.2)

Or with named parameters:

 def hatch = new Hatch(size: 10, stroke: new Stroke("wheat",1.0), name: "slash")

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`	`name` The name of the pattern (vertline, horline, slash, backslash, plus, times)
`Expression`	`size` The size
`Stroke`	`stroke` The Stroke

Constructor Summary

Constructors
Constructor and description
`Hatch (Map map)` Create a new Hatch with named parameters.
`Hatch (java.lang.Object name, Stroke stroke, java.lang.Object size)` Create a new Hatch.
`Hatch (java.lang.Object name, Fill fill, Stroke stroke, java.lang.Object size)` Create a new Hatch with Fill and Stroke.
`Hatch (java.lang.Object name, Fill fill, java.lang.Object size)` Create a new Hatch with a Fill but no Stroke.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`apply(Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer
	`protected Graphic`	`createHatch()` Create a GeoTools Graphic based on this Hatch
	`protected void`	`prepare(Rule rule)` Prepare the GeoTools Rule by applying this Symbolizer
	`void`	`setName(java.lang.Object name)` Set the name of the pattern (vertline, horline, slash, backslash, plus, times)
	`void`	`setSize(java.lang.Object size)` Set the size
	`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 name
    
    The name of the pattern (vertline, horline, slash, backslash, plus, times)
  - Expression size
    
    The size
  - Stroke stroke
    
    The Stroke
- Constructor Detail
  - Hatch(Map map)
    
    Create a new Hatch with named parameters.
```
 def hatch = new Hatch(size: 10, stroke: new Stroke("wheat",1.0), name: "slash")
 
```
    Parameters:
    map - A Map of named parameters.
  - Hatch(java.lang.Object name, Stroke stroke, java.lang.Object size)
    
    Create a new Hatch.
```
 def hatch = new Hatch("times", new Stroke("wheat", 1.2, [5,2], "square", "bevel"), 12.2)
 
```
    Parameters:
    name - (vertline, horline, slash, backslash, plus, times)
    stroke - A Stroke
    size - The size
  - Hatch(java.lang.Object name, Fill fill, Stroke stroke, java.lang.Object size)
    
    Create a new Hatch with Fill and Stroke.
```
 def hatch = new Hatch("times", new Fill("blue"), new Stroke("wheat", 1.2, [5,2], "square", "bevel"), 12.2)
 
```
    Parameters:
    name - (vertline, horline, slash, backslash, plus, times)
    fill - A Fill
    stroke - A Stroke
    size - The size
  - Hatch(java.lang.Object name, Fill fill, java.lang.Object size)
    
    Create a new Hatch with a Fill but no Stroke.
```
 def hatch = new Hatch("times", new Fill("wheat"), 12.2)
 
```
    Parameters:
    name - (vertline, horline, slash, backslash, plus, times)
    fill - A Fill
    size - The size
- Method Detail
  - @java.lang.Override protected void apply(Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - protected Graphic createHatch()
    
    Create a GeoTools Graphic based on this Hatch
    Returns:
    A GeoTools Graphic
  - @java.lang.Override protected void prepare(Rule rule)
    
    Prepare the GeoTools Rule by applying this Symbolizer
    Parameters:
    rule - The GeoTools Rule
  - void setName(java.lang.Object name)
    
    Set the name of the pattern (vertline, horline, slash, backslash, plus, times)
    Parameters:
    name - The name of the pattern (vertline, horline, slash, backslash, plus, times)
  - void setSize(java.lang.Object size)
    
    Set the size
    Parameters:
    size - The size
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Hatch

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

Fill fill

Expression name

Expression size

Stroke stroke

Constructor Detail

Hatch(Map map)

Hatch(java.lang.Object name, Stroke stroke, java.lang.Object size)

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

Hatch(java.lang.Object name, Fill fill, java.lang.Object size)

Method Detail

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

protected Graphic createHatch()

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

void setName(java.lang.Object name)

void setSize(java.lang.Object size)

java.lang.String toString()