Shape (Groovy Documentation)

geoscript.style.Shape

A Symbolizer for point geometries that consists of a color and size.
You can create a new Shape with a color, size, type, opacity, and rotation angle:
```
 def shape = new Shape("#ff0000", 8, "circle", 0.55, 0)
 
```
Or with named parameters:
```
 def shape = new Shape(type: "star", size: 4, color: "#ff00ff")
 
```
Authors:
Jared Erickson

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

Properties Summary

Properties
Type	Name and description
`java.lang.Object`	`anchorPoint` The anchor point
`Expression`	`color` The color (#ff000, blue, [255,255,0])
`java.lang.Object`	`displacement` The displacement
`Expression`	`opacity` The opacity (0: transparent - 1 opaque)
`Expression`	`rotation` The rotation angle (0-360 or a geoscript.filter.Function)
`Expression`	`size` The size (6, 10, 12, ect...)
`Stroke`	`stroke` The Stroke
`Expression`	`type` The type (circle, square, triangle, star, cross, or x).

Constructor Summary

Constructors
Constructor and description
`Shape ()` Create a new Shape
`Shape (Map map)` Create a new Shape with named parameters.
`Shape (java.lang.Object color, java.lang.Object size = 6, java.lang.Object type = "circle", java.lang.Object opacity = 1.0, java.lang.Object angle = 0)` Create a new Shape.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`apply(Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer
	`protected Graphic`	`createGraphic(Symbolizer sym)` Create a GeoTools Graphic from The GeoTools Symbolizer.
	`protected Mark`	`createMark()` Create a GeoTools Mark from this Shape
	`protected void`	`prepare(Rule rule)` Prepare the GeoTools Rule by applying this Symbolizer
	`void`	`setAnchorPoint(java.util.List anchorPoints)` Set the anchor points (List of two values between 0 and 1)
	`void`	`setColor(java.lang.Object color)` Set the color
	`void`	`setDisplacement(java.util.List displacements)` Set the displacement (List of two values between 0 and 1)
	`void`	`setOpacity(java.lang.Object opacity)` Set the opacity (0: transparent - 1 opaque)
	`void`	`setRotation(java.lang.Object rotation)` Set the rotation angle (0-360 or a geoscript.filter.Function)
	`void`	`setSize(java.lang.Object size)` Set the size
	`void`	`setType(java.lang.Object type)` Set the type (circle, square, triangle, star, cross, or x).
	`Shape`	`stroke(java.lang.Object color = "#000000", java.lang.Object width = 1, java.lang.Object dash = null, java.lang.Object cap = null, java.lang.Object join = null)` Add a Stroke to this Shape
	`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
  - java.lang.Object anchorPoint
    
    The anchor point
  - Expression color
    
    The color (#ff000, blue, [255,255,0])
  - java.lang.Object displacement
    
    The displacement
  - Expression opacity
    
    The opacity (0: transparent - 1 opaque)
  - Expression rotation
    
    The rotation angle (0-360 or a geoscript.filter.Function)
  - Expression size
    
    The size (6, 10, 12, ect...)
  - Stroke stroke
    
    The Stroke
  - Expression type
    
    The type (circle, square, triangle, star, cross, or x).
- Constructor Detail
  - Shape()
    
    Create a new Shape
  - Shape(Map map)
    
    Create a new Shape with named parameters.
```
 def shape = new Shape(type: "star", size: 4, color: "#ff00ff")
 
```
    Parameters:
    map - A Map of named parameters.
  - Shape(java.lang.Object color, java.lang.Object size = 6, java.lang.Object type = "circle", java.lang.Object opacity = 1.0, java.lang.Object angle = 0)
    
    Create a new Shape.
```
 def shape = new Shape("#ff0000", 8, "circle", 0.55, 0)
 
```
    Parameters:
    color - The color
    size - The size
    type - The type
    opacity - The opacity (0-1)
    angle - The angle or rotation (0-360)
- Method Detail
  - @java.lang.Override protected void apply(Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - protected Graphic createGraphic(Symbolizer sym)
    
    Create a GeoTools Graphic from The GeoTools Symbolizer.
    Parameters:
    sym - The GeoTools Symbolizer
    Returns:
    A GeoTools Graphic
  - protected Mark createMark()
    
    Create a GeoTools Mark from this Shape
    Returns:
    A GeoTools Mark
  - @java.lang.Override protected void prepare(Rule rule)
    
    Prepare the GeoTools Rule by applying this Symbolizer
    Parameters:
    rule - The GeoTools Rule
  - void setAnchorPoint(java.util.List anchorPoints)
    
    Set the anchor points (List of two values between 0 and 1)
    Parameters:
    anchorPoints - A List of two values between 0 and 1
  - void setColor(java.lang.Object color)
    
    Set the color
    Parameters:
    color - The color (#ffffff, red)
  - void setDisplacement(java.util.List displacements)
    
    Set the displacement (List of two values between 0 and 1)
    Parameters:
    displacement - A List of two values between 0 and 1
  - void setOpacity(java.lang.Object opacity)
    
    Set the opacity (0: transparent - 1 opaque)
    Parameters:
    opacity - The opacity (0: transparent - 1 opaque)
  - void setRotation(java.lang.Object rotation)
    
    Set the rotation angle (0-360 or a geoscript.filter.Function)
    Parameters:
    rotation - The rotation angle (0-360 or a geoscript.filter.Function)
  - void setSize(java.lang.Object size)
    
    Set the size
    Parameters:
    size - The size
  - void setType(java.lang.Object type)
    
    Set the type (circle, square, triangle, star, cross, or x).
    Parameters:
    type - The type (circle, square, triangle, star, cross, or x).
  - Shape stroke(java.lang.Object color = "#000000", java.lang.Object width = 1, java.lang.Object dash = null, java.lang.Object cap = null, java.lang.Object join = null)
    
    Add a Stroke to this Shape
    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)
    Returns:
    This Shape
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Shape

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.Object anchorPoint

Expression color

java.lang.Object displacement

Expression opacity

Expression rotation

Expression size

Stroke stroke

Expression type

Constructor Detail

Shape()

Shape(Map map)

Shape(java.lang.Object color, java.lang.Object size = 6, java.lang.Object type = "circle", java.lang.Object opacity = 1.0, java.lang.Object angle = 0)

Method Detail

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

protected Graphic createGraphic(Symbolizer sym)

protected Mark createMark()

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

void setAnchorPoint(java.util.List anchorPoints)

void setColor(java.lang.Object color)

void setDisplacement(java.util.List displacements)

void setOpacity(java.lang.Object opacity)

void setRotation(java.lang.Object rotation)

void setSize(java.lang.Object size)

void setType(java.lang.Object type)

Shape stroke(java.lang.Object color = "#000000", java.lang.Object width = 1, java.lang.Object dash = null, java.lang.Object cap = null, java.lang.Object join = null)

java.lang.String toString()