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

Properties Summary

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

Constructor Summary

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

Methods Summary

Methods
Type	Name and description
`protected void`	`apply(org.geotools.styling.Symbolizer sym)` Apply this Symbolizer to the GeoTools Symbolizer
`protected void`	`prepare(org.geotools.styling.Rule rule)` Prepare the GeoTools Rule by applying this Symbolizer
`void`	`setFormat(java.lang.String fmt)` Set the format
`void`	`setSize(java.lang.Object size)` Set the size of the icon
`void`	`setUrl(java.lang.Object url)` Set the URL
`java.lang.String`	`toString()` The string representation

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface org.geotools.styling.Symbolizer`	org.geotools.styling.Symbolizer#accept(org.geotools.styling.StyleVisitor), org.geotools.styling.Symbolizer#setName(java.lang.String), org.geotools.styling.Symbolizer#hasOption(java.lang.String), org.geotools.styling.Symbolizer#getOptions(), org.geotools.styling.Symbolizer#getDescription(), org.geotools.styling.Symbolizer#getDescription(), org.geotools.styling.Symbolizer#setDescription(org.opengis.style.Description), org.geotools.styling.Symbolizer#getGeometry(), org.geotools.styling.Symbolizer#setGeometry(org.opengis.filter.expression.Expression), org.geotools.styling.Symbolizer#setUnitOfMeasure(javax.measure.unit.Unit), org.geotools.styling.Symbolizer#getGeometryPropertyName(), org.geotools.styling.Symbolizer#setGeometryPropertyName(java.lang.String), org.geotools.styling.Symbolizer#getName(), org.geotools.styling.Symbolizer#accept(org.opengis.style.StyleVisitor, java.lang.Object), org.geotools.styling.Symbolizer#getUnitOfMeasure()
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), 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()`

- Property Detail
  - java.lang.String format
    
    The mime type of the image (image/png)
  - Expression size
    
    The size of the Icon (default to -1 which means auto-size)
  - java.net.URL url
    
    The location of the source image
- Constructor Detail
  - Icon(java.util.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 = null, java.lang.Object size = -1)
    
    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)
- Method Detail
  - @java.lang.Override protected void apply(org.geotools.styling.Symbolizer sym)
    
    Apply this Symbolizer to the GeoTools Symbolizer
    Parameters:
    sym - The GeoTools Symbolizer
  - @java.lang.Override protected void prepare(org.geotools.styling.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

java.lang.String format

Expression size

java.net.URL url

Constructor Detail

Icon(java.util.Map map)

Icon(java.lang.Object url, java.lang.String format = null, java.lang.Object size = -1)

Method Detail

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

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

void setFormat(java.lang.String fmt)

void setSize(java.lang.Object size)

void setUrl(java.lang.Object url)

java.lang.String toString()