RasterSymbolizer (Groovy Documentation)

geoscript.style.RasterSymbolizer

A Raster Symbolizer is used to style Rasters. It is also a base class for all other Raster Symbolizers.
Most commonly you will only use the RasterSymbolizer to control opacity:
```
 def raster = new RasterSymbolizer(0.5)
 
```
But you can also control overlap and geometry name properties:
```
 def raster = new RasterSymbolizer(0.75, "AVERAGE", "the_geom")
 
```
Authors:
Jared Erickson

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

Properties Summary

Properties
Type	Name and description
`Expression`	`geometry` The geometry name
`Expression`	`opacity` The overall opacity of the Raster Symbolizer
`Expression`	`overlap` How overalapping rasters are handled (LATEST_ON_TOP, EARLIEST_ON_TOP, AVERAGE, RANDOM)

Constructor Summary

Constructors
Constructor and description
`RasterSymbolizer (java.lang.Object opacity = 1.0, java.lang.Object overlap = null, java.lang.Object geometry = null)` Create a new Raster Symbolizer
`RasterSymbolizer (Map map)` Create a new Raster Symbolizer from named parameters.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`apply(Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer
	`RasterSymbolizer`	`geometry(java.lang.Object geometry)` Set the geometry name
	`RasterSymbolizer`	`opacity(java.lang.Object opacity)` Set the opacity (0-1)
	`RasterSymbolizer`	`overlap(java.lang.Object overlap)` Set the overlap value (LATEST_ON_TOP, EARLIEST_ON_TOP, AVERAGE, RANDOM)
	`protected void`	`prepare(Rule rule)` Prepare the GeoTools Rule by applying this Symbolizer
	`void`	`setGeometry(java.lang.Object geometry)` Set the geometry name
	`void`	`setOpacity(java.lang.Object opacity)` Set the opacity (0-1)
	`void`	`setOverlap(java.lang.Object overlap)` Set the overlap value (LATEST_ON_TOP, EARLIEST_ON_TOP, AVERAGE, RANDOM)
	`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 geometry
    
    The geometry name
  - Expression opacity
    
    The overall opacity of the Raster Symbolizer
  - Expression overlap
    
    How overalapping rasters are handled (LATEST_ON_TOP, EARLIEST_ON_TOP, AVERAGE, RANDOM)
- Constructor Detail
  - RasterSymbolizer(java.lang.Object opacity = 1.0, java.lang.Object overlap = null, java.lang.Object geometry = null)
    
    Create a new Raster Symbolizer
    Parameters:
    opacity - The opacity
    overlap - The overlap value
    geometry - The geometry name
  - RasterSymbolizer(Map map)
    
    Create a new Raster Symbolizer from named parameters.
    Parameters:
    map - The 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
  - RasterSymbolizer geometry(java.lang.Object geometry)
    
    Set the geometry name
    Parameters:
    geometry - The geometry name
    Returns:
    This Raster Symbolizer
  - RasterSymbolizer opacity(java.lang.Object opacity)
    
    Set the opacity (0-1)
    Parameters:
    opacity - The opacity (0-1)
    Returns:
    This Raster Symbolizer
  - RasterSymbolizer overlap(java.lang.Object overlap)
    
    Set the overlap value (LATEST_ON_TOP, EARLIEST_ON_TOP, AVERAGE, RANDOM)
    Parameters:
    overlap - The overlap value (LATEST_ON_TOP, EARLIEST_ON_TOP, AVERAGE, RANDOM)
    Returns:
    This Raster Symbolizer
  - @java.lang.Override protected void prepare(Rule rule)
    
    Prepare the GeoTools Rule by applying this Symbolizer
    Parameters:
    rule - The GeoTools Rule
  - void setGeometry(java.lang.Object geometry)
    
    Set the geometry name
    Parameters:
    geometry - The geometry name
  - void setOpacity(java.lang.Object opacity)
    
    Set the opacity (0-1)
    Parameters:
    opacity - The opacity (0-1)
  - void setOverlap(java.lang.Object overlap)
    
    Set the overlap value (LATEST_ON_TOP, EARLIEST_ON_TOP, AVERAGE, RANDOM)
    Parameters:
    overlap - The overlap value (LATEST_ON_TOP, EARLIEST_ON_TOP, AVERAGE, RANDOM)
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class RasterSymbolizer

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

Expression geometry

Expression opacity

Expression overlap

Constructor Detail

RasterSymbolizer(java.lang.Object opacity = 1.0, java.lang.Object overlap = null, java.lang.Object geometry = null)

RasterSymbolizer(Map map)

Method Detail

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

RasterSymbolizer geometry(java.lang.Object geometry)

RasterSymbolizer opacity(java.lang.Object opacity)

RasterSymbolizer overlap(java.lang.Object overlap)

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

void setGeometry(java.lang.Object geometry)

void setOpacity(java.lang.Object opacity)

void setOverlap(java.lang.Object overlap)

java.lang.String toString()