Viewer (Groovy Documentation)

geoscript.viewer.Viewer

class Viewer
extends java.lang.Object

A Viewer can be used to visualize Geometry.

 import geoscript.geom.Point
 import geoscript.viewer.Viewer
 Point p = new Point(10,10)
 Viewer.draw(p.buffer(100))

Or you can plot a List of Geometries.

 import geoscript.geom.Point
 import geoscript.viewer.Viewer
 Point p = new Point(10,10)
 Viewer.plot([p, p.buffer(50), p.buffer(100)])

Authors:: Jared Erickson

Constructor Summary

Constructors
Constructor and description
`Viewer()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static void`	`draw(java.util.Map options, java.lang.Object geom)` Draw a Geometry (or List of Geometries) onto a GUI
	`static void`	`draw(java.util.Map options, java.awt.Graphics2D g2d, java.util.List geometries)` Draw a List of GeoScript Geometries to a Graphics2D.
	`static java.lang.String`	`drawToBase64EncodedString(java.util.Map options, java.lang.Object geom)` Draw Geometry (or List of Geometries) to a Base64 Encoded String
	`static void`	`drawToFile(java.util.Map options, java.lang.Object geom, java.io.File file)` Save a drawing of the Geometry (or List of Geometries) to a File
	`static java.awt.image.BufferedImage`	`drawToImage(java.util.Map options, java.lang.Object geom)` Draw Geometry (or List of Geometries) to a BufferedImage

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
  - Viewer()
- Method Detail
  - static void draw(java.util.Map options, java.lang.Object geom)
    
    Draw a Geometry (or List of Geometries) onto a GUI
    Parameters:
    options - A Map of options or named parameters
    
    size = The size of the image
    
    bounds = The Bounds
    
    strokeColor = The stroke color
    
    fillColor = The fill color
    
    markerShape = The marker shape (circle, square, cross, ect...)
    
    markerSize = The marker size
    
    opacity = The opacity
    
    strokeWidth = The stroke width
    
    drawCoords = Whether to draw coordinates or not (true | false)
    geom - The Geometry to List of Geometries to render
  - static void draw(java.util.Map options, java.awt.Graphics2D g2d, java.util.List geometries)
    
    Draw a List of GeoScript Geometries to a Graphics2D.
    Parameters:
    options - A Map of options or named parameters
    
    size = The size of the image
    
    bounds = The Bounds
    
    strokeColor = The stroke color
    
    fillColor = The fill color
    
    markerShape = The marker shape (circle, square, cross, ect...)
    
    markerSize = The marker size
    
    opacity = The opacity
    
    strokeWidth = The stroke width
    
    drawCoords = Whether to draw coordinates or not (true | false)
    g2d - The Graphics2D
    geometries - A List of GeoScript Geometries
  - static java.lang.String drawToBase64EncodedString(java.util.Map options, java.lang.Object geom)
    
    Draw Geometry (or List of Geometries) to a Base64 Encoded String
    Parameters:
    options - A Map of options or named parameters
    
    size = The size of the image
    
    bounds = The Bounds
    
    strokeColor = The stroke color
    
    fillColor = The fill color
    
    markerShape = The marker shape (circle, square, cross, ect...)
    
    markerSize = The marker size
    
    opacity = The opacity
    
    strokeWidth = The stroke width
    
    drawCoords = Whether to draw coordinates or not (true | false)
    
    includePrefix = Whether to include the base 64 prefix
    
    imageType = The image type (PNG or JPEG)
    geom - A Geometry or a List of Geometries
    Returns:
    A Base64 Encoded String
  - static void drawToFile(java.util.Map options, java.lang.Object geom, java.io.File file)
    
    Save a drawing of the Geometry (or List of Geometries) to a File
    Parameters:
    options - A Map of options or named parameters
    geom - A Geometry or a List of Geometries
    file - The File
  - static java.awt.image.BufferedImage drawToImage(java.util.Map options, java.lang.Object geom)
    
    Draw Geometry (or List of Geometries) to a BufferedImage
    Parameters:
    options - A Map of options or named parameters
    
    size = The size of the image
    
    bounds = The Bounds
    
    strokeColor = The stroke color
    
    fillColor = The fill color
    
    markerShape = The marker shape (circle, square, cross, ect...)
    
    markerSize = The marker size
    
    opacity = The opacity
    
    strokeWidth = The stroke width
    
    drawCoords = Whether to draw coordinates or not (true | false)
    geom - A Geometry or a List of Geometries
    Returns:
    A BufferedImage

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class Viewer

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

Viewer()

Method Detail

static void draw(java.util.Map options, java.lang.Object geom)

static void draw(java.util.Map options, java.awt.Graphics2D g2d, java.util.List geometries)

static java.lang.String drawToBase64EncodedString(java.util.Map options, java.lang.Object geom)

static void drawToFile(java.util.Map options, java.lang.Object geom, java.io.File file)

static java.awt.image.BufferedImage drawToImage(java.util.Map options, java.lang.Object geom)