Stroke (Groovy Documentation)

geoscript.style.Stroke

```
class Stroke
extends Symbolizer
```
A Symbolizer for linear geometries that consists of a color and a width.
You can create a Stroke with a color and width:
```
 def shape = new Shape("#ff0000", 0.25)
 
```
Or with named parameters:
```
 def stroke = new Stroke(width: 1.2, dash: [5,2], color: "#ff00ff", opacity: 0.75)
 
```
Authors:
Jared Erickson

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

Properties Summary

Properties
Type	Name and description
`Expression`	`cap` The line cap (butt, round, square)
`Expression`	`color` The color in hexadecimal format (#00FF00)
`java.util.List`	`dash` The dash pattern.
`Hatch`	`hatch` The Hatch
`Expression`	`join` The line join (miter, round, bevel)
`Expression`	`opacity` The opacity (0: transparent - 1 opaque)
`Expression`	`perpendicularOffset` The perpendicular offset
`Shape`	`shape` The Shape for spaced graphics
`Expression`	`width` The width (1, 2, 5, ect...)

Constructor Summary

Constructors
Constructor and description
`Stroke (java.lang.Object color, java.lang.Object width, java.util.List dash, java.lang.Object cap, java.lang.Object join, java.lang.Object opacity)` Create a new Stroke.
`Stroke (Map map)` Create a new Stroke with named parameters.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`apply(Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer
	`protected Stroke`	`createStroke()` Create a GeoTools Stroke from this GeoScript Stroke
	`Stroke`	`hatch(java.lang.Object name, Stroke stroke, java.lang.Object size)` Add a Hatch pattern to this Stroke
	`Stroke`	`perpendicularOffset(java.lang.Object offset)` Set the perpendicular offset
	`protected void`	`prepare(Rule rule)` Prepare the GeoTools Rule by applying this Symbolizer
	`void`	`setCap(java.lang.Object cap)` Set the line cap(butt, round, square)
	`void`	`setColor(java.lang.Object color)` Set the color
	`void`	`setJoin(java.lang.Object join)` Set the line join(miter, round, bevel)
	`void`	`setOpacity(java.lang.Object opacity)` Set the opacity (0: transparent - 1 opaque)
	`void`	`setPerpendicularOffset(java.lang.Object offset)` Set the perpendicular offset
	`void`	`setWidth(java.lang.Object width)` Set the width
	`Stroke`	`shape(Shape shape)` Add a Shape to this Stroke for creating spaced graphic symbols
	`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
  - Expression cap
    
    The line cap (butt, round, square)
  - Expression color
    
    The color in hexadecimal format (#00FF00)
  - java.util.List dash
    
    The dash pattern. Odd items specify length in pixels of the dash. Even items specify spaces.
  - Hatch hatch
    
    The Hatch
  - Expression join
    
    The line join (miter, round, bevel)
  - Expression opacity
    
    The opacity (0: transparent - 1 opaque)
  - Expression perpendicularOffset
    
    The perpendicular offset
  - Shape shape
    
    The Shape for spaced graphics
  - Expression width
    
    The width (1, 2, 5, ect...)
- Constructor Detail
  - Stroke(java.lang.Object color, java.lang.Object width, java.util.List dash, java.lang.Object cap, java.lang.Object join, java.lang.Object opacity)
    
    Create a new Stroke.
```
 def stroke = new Stroke("#ff0000", 0.25, [5,2], "round", "bevel")
 
```
    Parameters:
    color - The color
    width - The width
    dash - The dash pattern
    cap - The line cap (round, butt, square)
    join - The line join (mitre, round, bevel)
  - Stroke(Map map)
    
    Create a new Stroke with named parameters.
```
 def stroke = new Stroke(width: 1.2, dash: [5,2], color: "#ff00ff", opacity: 0.75)
 
```
    Parameters:
    map - A Map of named parameters.
- Method Detail
  - @java.lang.Override protected void apply(Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - protected Stroke createStroke()
    
    Create a GeoTools Stroke from this GeoScript Stroke
    Returns:
    A GeoTools Stroke
  - Stroke hatch(java.lang.Object name, Stroke stroke, java.lang.Object size)
    
    Add a Hatch pattern to this Stroke
    Parameters:
    name - The pattern name
    stroke - The Stroke
    size - The size
    Returns:
    This Stroke
  - Stroke perpendicularOffset(java.lang.Object offset)
    
    Set the perpendicular offset
    Parameters:
    offset - The offset
    Returns:
    This Stroke
  - @java.lang.Override protected void prepare(Rule rule)
    
    Prepare the GeoTools Rule by applying this Symbolizer
    Parameters:
    rule - The GeoTools Rule
  - void setCap(java.lang.Object cap)
    
    Set the line cap(butt, round, square)
    Parameters:
    cap - The line cap
  - void setColor(java.lang.Object color)
    
    Set the color
    Parameters:
    color - The color (#ffffff, red)
  - void setJoin(java.lang.Object join)
    
    Set the line join(miter, round, bevel)
    Parameters:
    join - The line join
  - void setOpacity(java.lang.Object opacity)
    
    Set the opacity (0: transparent - 1 opaque)
    Parameters:
    opacity - The opacity (0: transparent - 1 opaque)
  - void setPerpendicularOffset(java.lang.Object offset)
    
    Set the perpendicular offset
    Parameters:
    offset - The offset
    Returns:
    This Stroke
  - void setWidth(java.lang.Object width)
    
    Set the width
    Parameters:
    width - The width
  - Stroke shape(Shape shape)
    
    Add a Shape to this Stroke for creating spaced graphic symbols
    Parameters:
    shape - The Shape
    Returns:
    This Stroke
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Stroke

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

Expression cap

Expression color

java.util.List dash

Hatch hatch

Expression join

Expression opacity

Expression perpendicularOffset

Shape shape

Expression width

Constructor Detail

Stroke(java.lang.Object color, java.lang.Object width, java.util.List dash, java.lang.Object cap, java.lang.Object join, java.lang.Object opacity)

Stroke(Map map)

Method Detail

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

protected Stroke createStroke()

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

Stroke perpendicularOffset(java.lang.Object offset)

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

void setCap(java.lang.Object cap)

void setColor(java.lang.Object color)

void setJoin(java.lang.Object join)

void setOpacity(java.lang.Object opacity)

void setPerpendicularOffset(java.lang.Object offset)

void setWidth(java.lang.Object width)

Stroke shape(Shape shape)

java.lang.String toString()