Icon (Groovy Documentation)

geoscript.style.Icon

A Symbolizer for an external image or glyph.
You can create an Icon from a File/URL/URI and a mime type:
```
 def icon = new Icon("images/star.png", "image/png")
 
```
Or with named parameters:
```
 def icon = new Icon(format: "image/png", url: "images/star.png")
 
```
Authors:
Jared Erickson

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

Properties Summary

Properties
Type	Name and description
`private java.lang.String`	`format` The mime type of the image (image/png)
`private Expression`	`size` The size of the Icon (default to -1 which means auto-size)
`private URL`	`url` The location of the source image

Constructor Summary

Constructors
Constructor and description
`Icon (Map map)` Create a new Icon with named parameters.
`Icon (java.lang.Object url, java.lang.String format, java.lang.Object size)` Create a new Icon.
`Icon ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected void`	`apply(Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer Parameters: `sym` - The GeoTools Symbolizer
	`protected void`	`prepare(Rule rule)` Prepare the GeoTools Rule by applying this Symbolizer Parameters: `rule` - The GeoTools Rule
	`void`	`setFormat(java.lang.String fmt)` Set the format Parameters: `fmt` - The format
	`void`	`setSize(java.lang.Object size)` Set the size of the icon Parameters: `size` - The size
	`void`	`setUrl(java.lang.Object url)` Set the URL Parameters: `url` - A URL, URI, or File
	`java.lang.String`	`toString()` The string representation Returns: 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
  - private java.lang.String format
    
    The mime type of the image (image/png)
  - private Expression size
    
    The size of the Icon (default to -1 which means auto-size)
  - private URL url
    
    The location of the source image
- Constructor Detail
  - Icon(Map map)
    
    Create a new Icon with named parameters.
```
 def icon = new Icon(format: "image/png", url: "images/star.png")
 
```
    Parameters:
    map - A Map of named parameters.
  - Icon(java.lang.Object url, java.lang.String format, java.lang.Object size)
    
    Create a new Icon.
```
 def icon = new 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)
  - Icon()
- Method Detail
  - @java.lang.OverrideOverride protected void apply(Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - @java.lang.OverrideOverride protected void prepare(Rule rule)
    
    Prepare the GeoTools Rule by applying this Symbolizer
    Parameters:
    rule - The GeoTools Rule
  - void setFormat(java.lang.String fmt)
    
    Set the format
    Parameters:
    fmt - The format
  - void setSize(java.lang.Object size)
    
    Set the size of the icon
    Parameters:
    size - The size
  - void setUrl(java.lang.Object url)
    
    Set the URL
    Parameters:
    url - A URL, URI, or File
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Icon

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

private java.lang.String format

private Expression size

private URL url

Constructor Detail

Icon(Map map)

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

Icon()

Method Detail

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

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

void setFormat(java.lang.String fmt)

void setSize(java.lang.Object size)

void setUrl(java.lang.Object url)

java.lang.String toString()