Hatch (Groovy Documentation)

geoscript.style.Hatch

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

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 (java.util.Map map)` Create a new Hatch with named parameters.
`Hatch (java.lang.Object name, Stroke stroke = new Stroke(, java.lang.Object size = 8)` 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	Name and description
`protected void`	`apply(org.geotools.styling.Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer
`protected org.geotools.styling.Graphic`	`createHatch()` Create a GeoTools Graphic based on this Hatch
`protected void`	`prepare(org.geotools.styling.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
`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 name
    
    The name of the pattern (vertline, horline, slash, backslash, plus, times)
  - Expression size
    
    The size
  - Stroke stroke
    
    The Stroke
- Constructor Detail
  - Hatch(java.util.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 = new Stroke(, java.lang.Object size = 8)
    
    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(org.geotools.styling.Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - protected org.geotools.styling.Graphic createHatch()
    
    Create a GeoTools Graphic based on this Hatch
    Returns:
    A GeoTools Graphic
  - @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 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(java.util.Map map)

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

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(org.geotools.styling.Symbolizer sym)

protected org.geotools.styling.Graphic createHatch()

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

void setName(java.lang.Object name)

void setSize(java.lang.Object size)

java.lang.String toString()