Map (Groovy Documentation)

geoscript.render.Map

class Map
extends java.lang.Object

The GeoScript Map for rendering Layers.

 import geoscript.render.*
 import geoscript.layer.*
 import geoscript.style.*

 Map map = new Map(layers:[new Shapefile("states.shp")])
 map.renderToImage()

Authors:: Jared Erickson

Field Summary

Fields
Modifiers	Name	Description
`protected MapContent`	`content`	The GeoTools MapContent
`protected GTRenderer`	`renderer`	The GeoTools Renderer

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`backgroundColor` The background color (if any)
`Bounds`	`bounds`
`boolean`	`fixAspectRatio` A flag to fix the aspect ration (true) or not (false)
`int`	`height` The height of the Map
`java.util.List`	`layers` The List of Layers
`java.lang.Object`	`proj`
`java.lang.String`	`type` The output type (png, jpg, pdf, svg, base64)
`int`	`width` The width of the Map

Constructor Summary

Constructors
Constructor and description
`Map ()` Create a new Map

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addLayer(Layer layer)` Add a Layer
	`void`	`addLayer(Renderable renderable)` Add a Renderable Map Layer
	`void`	`addRaster(Raster raster)` Add a Raster
	`void`	`addTileLayer(TileLayer layer)` Add a TileLayer
	`void`	`close()` Closes the Map by disposing of any resources.
	`void`	`display()` Display the Map in an interactive GUI
	`Bounds`	`getBounds()` Get the Bounds
	`Projection`	`getProj()` Get the Map's Projection
	`double`	`getScaleDenominator()` Get the scale denominator
	`void`	`render(java.lang.String fileName)` Render the Map at a Bounds to a file name
	`void`	`render(java.io.File file)` Render the Map at a Bounds to a File
	`void`	`render(java.io.OutputStream out)` Render the Map at a Bounds to an OutputStream
	`void`	`render(java.awt.Graphics2D g)` Render the Map directly to a Graphics2D context
	`java.awt.image.BufferedImage`	`renderToImage()` Render the Map to a BufferedImage for the given Bounds
	`Map`	`setAdvancedProjectionHandling(boolean value)` Set whether to use advanced projection handling or not.
	`void`	`setBackgroundColor(java.lang.Object color)` Set the background color
	`void`	`setBounds(Bounds bounds)` Set the Bounds
	`Map`	`setContinuousMapWrapping(boolean value)` Set whether to enable continuous map wrapping or not.
	`void`	`setProj(java.lang.Object projection)` Set the Map Projection
	`Map`	`setScaleComputation(java.lang.String type)` Set the scale computation algorithm (accurate or ogc).
	`protected void`	`setUpRendering()` Set up for rendering (add layers, configure bounds and projection)

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`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()`

- Field Detail
  - protected MapContent content
    
    The GeoTools MapContent
  - protected GTRenderer renderer
    
    The GeoTools Renderer
- Property Detail
  - java.lang.String backgroundColor
    
    The background color (if any)
  - Bounds bounds
  - boolean fixAspectRatio
    
    A flag to fix the aspect ration (true) or not (false)
  - int height
    
    The height of the Map
  - java.util.List layers
    
    The List of Layers
  - java.lang.Object proj
  - java.lang.String type
    
    The output type (png, jpg, pdf, svg, base64)
  - int width
    
    The width of the Map
- Constructor Detail
  - Map()
    
    Create a new Map
- Method Detail
  - void addLayer(Layer layer)
    
    Add a Layer
    Parameters:
    layer - The Layer
  - void addLayer(Renderable renderable)
    
    Add a Renderable Map Layer
    Parameters:
    renderable - The Renderable Map Layer
  - void addRaster(Raster raster)
    
    Add a Raster
    Parameters:
    raster - The Raster
  - void addTileLayer(TileLayer layer)
    
    Add a TileLayer
    Parameters:
    layer - The TileLayer
  - void close()
    
    Closes the Map by disposing of any resources.
  - void display()
    
    Display the Map in an interactive GUI
  - Bounds getBounds()
    
    Get the Bounds
    Returns:
    The Bounds
  - Projection getProj()
    
    Get the Map's Projection
    Returns:
    The Map's Projection
  - double getScaleDenominator()
    
    Get the scale denominator
    Parameters:
    The - scale denminator
  - void render(java.lang.String fileName)
    
    Render the Map at a Bounds to a file name
    Parameters:
    bounds - The Bounds
    fileName - The file name
  - void render(java.io.File file)
    
    Render the Map at a Bounds to a File
    Parameters:
    bounds - The Bounds
    file - The File
  - void render(java.io.OutputStream out)
    
    Render the Map at a Bounds to an OutputStream
    Parameters:
    out - The OutputStream
  - void render(java.awt.Graphics2D g)
    
    Render the Map directly to a Graphics2D context
    Parameters:
    g - The Graphics2D context
  - java.awt.image.BufferedImage renderToImage()
    
    Render the Map to a BufferedImage for the given Bounds
    Returns:
    A BufferedImage
  - Map setAdvancedProjectionHandling(boolean value)
    
    Set whether to use advanced projection handling or not. The default is true.
    Parameters:
    value - Whether to use advanced projection handling or not.
    Returns:
    This Map
  - void setBackgroundColor(java.lang.Object color)
    
    Set the background color
    Parameters:
    color - The background color (#ffffff, red)
  - void setBounds(Bounds bounds)
    
    Set the Bounds
    Parameters:
    bounds - The Bounds
  - Map setContinuousMapWrapping(boolean value)
    
    Set whether to enable continuous map wrapping or not. The default is true.
    Parameters:
    value - Whether to enable continuous map wrapping ot not
    Returns:
    This Map
  - void setProj(java.lang.Object projection)
    
    Set the Map Projection
    Parameters:
    proj - The Projection
  - Map setScaleComputation(java.lang.String type)
    
    Set the scale computation algorithm (accurate or ogc). Accurate the default.
    Parameters:
    type - The scale computation algorithm (accurate or ogc).
    Returns:
    This Map
  - protected void setUpRendering()
    
    Set up for rendering (add layers, configure bounds and projection)

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Map

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected MapContent content

protected GTRenderer renderer

Property Detail

java.lang.String backgroundColor

Bounds bounds

boolean fixAspectRatio

int height

java.util.List layers

java.lang.Object proj

java.lang.String type

int width

Constructor Detail

Map()

Method Detail

void addLayer(Layer layer)

void addLayer(Renderable renderable)

void addRaster(Raster raster)

void addTileLayer(TileLayer layer)

void close()

void display()

Bounds getBounds()

Projection getProj()

double getScaleDenominator()

void render(java.lang.String fileName)

void render(java.io.File file)

void render(java.io.OutputStream out)

void render(java.awt.Graphics2D g)

java.awt.image.BufferedImage renderToImage()

Map setAdvancedProjectionHandling(boolean value)

void setBackgroundColor(java.lang.Object color)

void setBounds(Bounds bounds)

Map setContinuousMapWrapping(boolean value)

void setProj(java.lang.Object projection)

Map setScaleComputation(java.lang.String type)

protected void setUpRendering()