Symbolizers (Groovy Documentation)

geoscript.style.Symbolizers

class Symbolizers
extends java.lang.Object

The Symbolizers class is a collection of static methods that can be used to create Symbolizers.

 import static geoscript.style.Symbolizers.*

 Fill fill = fill("#003300", 0.65)
 Stroke stroke = stroke("wheat", 1.2, [5,2], "square", "bevel",0.45)

Constructor Summary

Constructors
Constructor and description
`Symbolizers ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static Fill`	`fill(java.lang.Object color, java.lang.Object opacity)` Create a new Fill.
	`static Fill`	`fill(Map properties)` Create a new Fill.
	`static Font`	`font(java.lang.Object style, java.lang.Object weight, java.lang.Object size, java.lang.Object family)` Create a new Font.
	`static Font`	`font(Map properties)` Create a new Font with named parameters.
	`static Gradient`	`gradient(java.lang.Object expression, java.util.List values, java.util.List styles, int classes, java.lang.String method, boolean inclusive)` Create a new Gradient by interpolating between a List of values and styles.
	`static Gradient`	`gradient(Layer layer, java.lang.Object field, java.lang.String method, int number, java.lang.Object colors, java.lang.String elseMode)` Create a new Gradient where the interpolation is based on a classification method based on values from the Layer's Field.
	`static Halo`	`halo(Fill fill, java.lang.Object radius)` Create a new Halo with a Fill and radius.
	`static Halo`	`halo(Map properties)` Create a new Halo with named parameters.
	`static Hatch`	`hatch(java.lang.Object name, Stroke stroke, java.lang.Object size)` Create a new Hatch.
	`static Hatch`	`hatch(Map map)` Create a new Hatch with named parameters.
	`static Icon`	`icon(Map map)` Create a new Icon with named parameters.
	`static Icon`	`icon(java.lang.Object url, java.lang.String format, java.lang.Object size)` Create a new Icon.
	`static Label`	`label(java.lang.Object property)` Create a new Label with a property which is a field or attribute with which to generate labels form.
	`static Label`	`label(Map map)` Create a new Label with named parameters.
	`static Shape`	`shape()` Create a new Shape.
	`static Shape`	`shape(Map map)` Create a new Shape with named parameters.
	`static Shape`	`shape(java.lang.Object color, java.lang.Object size, java.lang.Object type, java.lang.Object opacity, java.lang.Object angle)` Create a new Shape.
	`static Stroke`	`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.
	`static Stroke`	`stroke(Map properties)` Create a new Stroke with named parameters.
	`static Transform`	`transform(Function function)` Create a new Transform from a Function.
	`static Transform`	`transform(java.lang.String cql)` Create a new Transform from a CQL filter function.
	`static UniqueValues`	`uniqueValues(Layer layer, java.lang.Object field, java.lang.Object colors)` Create a new UniqueValues Composite.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), 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()`

- Constructor Detail
  - Symbolizers()
- Method Detail
  - static Fill fill(java.lang.Object color, java.lang.Object opacity)
    
    Create a new Fill.
```
 def f = fill('#ff0000', 0.5)
 def f = fill('red', 0.5)
 def f = fill([255,0,0], 0.5)
 
```
    Parameters:
    color - The Color
    opacity - The opacity (1 opaque to 0 transparent)
    Returns:
    A Fill
  - static Fill fill(Map properties)
    
    Create a new Fill.
```
 def f = fill(color: '#ff0000', opacity: 0.25)
 
```
    Parameters:
    properties - A Map of named parameters.
    Returns:
    A Fill
  - static Font font(java.lang.Object style, java.lang.Object weight, java.lang.Object size, java.lang.Object family)
    
    Create a new Font.
```
 def f = font("normal", "bold", 12, "Arial")
 
```
    Parameters:
    style - The Font style (normal, italic, oblique)
    weight - The Font weight (normal, bold)
    size - The Font size (8,10,12,24,ect...)
    family - The Font family (serif, Arial, Verdana)
    Returns:
    A Font
  - static Font font(Map properties)
    
    Create a new Font with named parameters.
```
 def f = font(weight: "bold", size: 32)
 
```
    Parameters:
    properties - A Map of named parameters.
    Returns:
    A Font
  - static Gradient gradient(java.lang.Object expression, java.util.List values, java.util.List styles, int classes, java.lang.String method, boolean inclusive)
    
    Create a new Gradient by interpolating between a List of values and styles.
```
 Gradient g = gradient("PERSONS / LAND_KM",[0,200],[new Fill("#000066"), new Fill("red")],10,"exponential")
 
```
    Parameters:
    expression - An Expression or a String expression.
    values - A List of values
    styles - A List of Styles
    classes - The number of classes
    method - The interpolation method (linear, exponential, logarithmic)
    inclusive - Whether to include the last value of not
  - static Gradient gradient(Layer layer, java.lang.Object field, java.lang.String method, int number, java.lang.Object colors, java.lang.String elseMode)
    
    Create a new Gradient where the interpolation is based on a classification method based on values from the Layer's Field.
```
 Gradient g = gradient(shapefile, "WORKERS", "Quantile", 5, "Greens")
 
```
    Parameters:
    layer - The Layer
    field - The Field or Field's name
    method - The classification method (Quantile or EqualInterval)
    number - The number of categories
    colors - A Color Brewer palette name, or a List of Colors
    elseMode - The else mode (ignore, min, max)
  - static Halo halo(Fill fill, java.lang.Object radius)
    
    Create a new Halo with a Fill and radius.
```
 def h = halo(new Fill("navy"), 2.5)
 
```
    Parameters:
    fill - The Fill
    radius - The radius
    Returns:
    A Halo
  - static Halo halo(Map properties)
    
    Create a new Halo with named parameters.
```
 def h = halo(fill: new Fill("navy"), radius: 2.5)
 
```
    Parameters:
    properties - A Map of named parameters.
    Returns:
    A Halo
  - static Hatch hatch(java.lang.Object name, Stroke stroke, java.lang.Object size)
    
    Create a new Hatch.
```
 def hatch = 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
    Returns:
    A Hatch
  - static Hatch hatch(Map map)
    
    Create a new Hatch with named parameters.
```
 def hatch = hatch(size: 10, stroke: new Stroke("wheat",1.0), name: "slash")
 
```
    Parameters:
    map - A Map of named parameters.
    Returns:
    A Hatch
  - static Icon icon(Map map)
    
    Create a new Icon with named parameters.
```
 def i = icon(format: "image/png", url: "images/star.png")
 
```
    Parameters:
    map - A Map of named parameters.
    Returns:
    An Icon
  - static Icon icon(java.lang.Object url, java.lang.String format, java.lang.Object size)
    
    Create a new Icon.
```
 def i = icon("images/star.png", "image/png")
 
```
    Parameters:
    url - The file or url of the icon
    format - The image format (image/png)
    size - The size of the Icon (default to -1 which means auto-size)
    Returns:
    An Icon
  - static Label label(java.lang.Object property)
    
    Create a new Label with a property which is a field or attribute with which to generate labels form.
```
 def l = label("STATE_ABBR")
 
```
    Parameters:
    property - The field or attribute
    Returns:
    A Label
  - static Label label(Map map)
    
    Create a new Label with named parameters.
```
 def l = label(property: "name", font: new Font(weight: "bold")))
 
```
    Parameters:
    map - A Map of named parameters.
    Returns:
    A Label
  - static Shape shape()
    
    Create a new Shape.
    Returns:
    A Shape
  - static Shape shape(Map map)
    
    Create a new Shape with named parameters.
```
 def s = shape(type: "star", size: 4, color: "#ff00ff")
 
```
    Parameters:
    map - A Map of named parameters.
    Returns:
    A Shape
  - static Shape shape(java.lang.Object color, java.lang.Object size, java.lang.Object type, java.lang.Object opacity, java.lang.Object angle)
    
    Create a new Shape.
```
 def s = 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)
    Returns:
    A Shape
  - static Stroke 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 = 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)
    Returns:
    A Stroke
  - static Stroke stroke(Map properties)
    
    Create a new Stroke with named parameters.
```
 def stroke = stroke(width: 1.2, dash: [5,2], color: "#ff00ff", opacity: 0.75)
 
```
    Parameters:
    properties - A Map of named parameters.
    Returns:
    A Stroke
  - static Transform transform(Function function)
    
    Create a new Transform from a Function.
```
 Transform t = transform(new Function("myCentroid", {g -> g.centroid}))
 
```
    Parameters:
    function - The geoscript.filter.Function
    Returns:
    A Transform
  - static Transform transform(java.lang.String cql)
    
    Create a new Transform from a CQL filter function.
```
 Transform t = transform("centroid(the_geom)")
 
```
    Parameters:
    cql - A CQL string
    Returns:
    A Transform
  - static UniqueValues uniqueValues(Layer layer, java.lang.Object field, java.lang.Object colors)
    
    Create a new UniqueValues Composite.
```
 UniqueValues values = uniqueValues(shp, "STATE_NAME")
 
```
    Parameters:
    layer - The Layer
    field - The Field or the Field's name
    colors - A Closure (which takes index based on 0 and a value), a Palette name, or a List of Colors

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class Symbolizers

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

Symbolizers()

Method Detail

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

static Fill fill(Map properties)

static Font font(java.lang.Object style, java.lang.Object weight, java.lang.Object size, java.lang.Object family)

static Font font(Map properties)

static Gradient gradient(java.lang.Object expression, java.util.List values, java.util.List styles, int classes, java.lang.String method, boolean inclusive)

static Gradient gradient(Layer layer, java.lang.Object field, java.lang.String method, int number, java.lang.Object colors, java.lang.String elseMode)

static Halo halo(Fill fill, java.lang.Object radius)

static Halo halo(Map properties)

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

static Hatch hatch(Map map)

static Icon icon(Map map)

static Icon icon(java.lang.Object url, java.lang.String format, java.lang.Object size)

static Label label(java.lang.Object property)

static Label label(Map map)

static Shape shape()

static Shape shape(Map map)

static Shape shape(java.lang.Object color, java.lang.Object size, java.lang.Object type, java.lang.Object opacity, java.lang.Object angle)

static Stroke 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)

static Stroke stroke(Map properties)

static Transform transform(Function function)

static Transform transform(java.lang.String cql)

static UniqueValues uniqueValues(Layer layer, java.lang.Object field, java.lang.Object colors)