Graticule (Groovy Documentation)

geoscript.layer.Graticule

Create graticule or grid Layers.

 Layer layer = Graticule.createHexagons(new Bounds(0,0,50,50), 5, 1, "angled")

Authors:: Jared Erickson

Constructor Summary

Constructors
Constructor and description
`Graticule ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static Layer`	`createHexagons(Map options, Bounds bounds, double length, double spacing, java.lang.String orientation)` Creates a hexagon polygon graticule.
	`static Layer`	`createLines(Map options, Bounds bounds, List lineDefs, double spacing)` Creates a line based graticule Parameters: `options` - The optional named parameters: workspace = The Workspace (defaults to Memory) layer = The new layer name (defaults to graticule) schema = The Schema (defaults to Polygon geometry and integer id attribute) setAttributes = A Closure that takes a GridElement and Map of attributes which you can use to set custom attributes createFeature = A Closure that takes a GridElement and return a boolean value whether the Feature should be created or not `bounds` - The Bounds `lineDefs` - A List of line definitions.
	`static Layer`	`createOvals(Map options, Bounds bounds, double length)` Creates a oval polygon graticule.
	`static Layer`	`createRectangles(Map options, Bounds bounds, double width, double height, double spacing)` Creates a rectangular polygon graticule Parameters: `options` - The optional named parameters: workspace = The Workspace (defaults to Memory) layer = The new layer name (defaults to graticule) schema = The Schema (defaults to Polygon geometry and integer id attribute) setAttributes = A Closure that takes a GridElement and Map of attributes which you can use to set custom attributes createFeature = A Closure that takes a GridElement and return a boolean value whether the Feature should be created or not `bounds` - The Bounds `width` - The cell width `height` - The cell height `spacing` - The vertex spacing (-1 for non densified) Returns: A Layer
	`static Layer`	`createSquares(Map options, Bounds bounds, double length, double spacing)` Creates a square polygon graticule.

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()`

- Constructor Detail
  - Graticule()
- Method Detail
  - static Layer createHexagons(Map options, Bounds bounds, double length, double spacing, java.lang.String orientation)
    
    Creates a hexagon polygon graticule.
    Parameters:
    options - The optional named parameters:
    
    workspace = The Workspace (defaults to Memory)
    
    layer = The new layer name (defaults to graticule)
    
    schema = The Schema (defaults to Polygon geometry and integer id attribute)
    
    setAttributes = A Closure that takes a GridElement and Map of attributes which you can use to set custom attributes
    
    createFeature = A Closure that takes a GridElement and return a boolean value whether the Feature should be created or not
    bounds - The Bounds
    length - The hexagon cell width and height
    spacing - The vertex spacing (-1 for non densified)
    orientation - The cell orientation (flat or angled)
    Returns:
    A Layer
  - static Layer createLines(Map options, Bounds bounds, List lineDefs, double spacing)
    
    Creates a line based graticule
    Parameters:
    options - The optional named parameters:
    
    workspace = The Workspace (defaults to Memory)
    
    layer = The new layer name (defaults to graticule)
    
    schema = The Schema (defaults to Polygon geometry and integer id attribute)
    
    setAttributes = A Closure that takes a GridElement and Map of attributes which you can use to set custom attributes
    
    createFeature = A Closure that takes a GridElement and return a boolean value whether the Feature should be created or not
    bounds - The Bounds
    lineDefs - A List of line definitions. Each line definition is a map with the following properties: orientation (vertical or horizontal), level, and spacing.
    spacing - The vertex spacing (-1 for non densified)
    Returns:
    A Layer
  - static Layer createOvals(Map options, Bounds bounds, double length)
    
    Creates a oval polygon graticule.
    Parameters:
    options - The optional named parameters:
    
    workspace = The Workspace (defaults to Memory)
    
    layer = The new layer name (defaults to graticule)
    
    schema = The Schema (defaults to Polygon geometry and integer id attribute)
    
    setAttributes = A Closure that takes a GridElement and Map of attributes which you can use to set custom attributes
    
    createFeature = A Closure that takes a GridElement and return a boolean value whether the Feature should be created or not
    bounds - The Bounds
    length - The square cell width and height
    Returns:
    A Layer
  - static Layer createRectangles(Map options, Bounds bounds, double width, double height, double spacing)
    
    Creates a rectangular polygon graticule
    Parameters:
    options - The optional named parameters:
    
    workspace = The Workspace (defaults to Memory)
    
    layer = The new layer name (defaults to graticule)
    
    schema = The Schema (defaults to Polygon geometry and integer id attribute)
    
    setAttributes = A Closure that takes a GridElement and Map of attributes which you can use to set custom attributes
    
    createFeature = A Closure that takes a GridElement and return a boolean value whether the Feature should be created or not
    bounds - The Bounds
    width - The cell width
    height - The cell height
    spacing - The vertex spacing (-1 for non densified)
    Returns:
    A Layer
  - static Layer createSquares(Map options, Bounds bounds, double length, double spacing)
    
    Creates a square polygon graticule.
    Parameters:
    options - The optional named parameters:
    
    workspace = The Workspace (defaults to Memory)
    
    layer = The new layer name (defaults to graticule)
    
    schema = The Schema (defaults to Polygon geometry and integer id attribute)
    
    setAttributes = A Closure that takes a GridElement and Map of attributes which you can use to set custom attributes
    
    createFeature = A Closure that takes a GridElement and return a boolean value whether the Feature should be created or not
    bounds - The Bounds
    length - The square cell width and height
    spacing - The vertex spacing (-1 for non densified)
    Returns:
    A Layer

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class Graticule

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

Graticule()

Method Detail

static Layer createHexagons(Map options, Bounds bounds, double length, double spacing, java.lang.String orientation)

static Layer createLines(Map options, Bounds bounds, List lineDefs, double spacing)

static Layer createOvals(Map options, Bounds bounds, double length)

static Layer createRectangles(Map options, Bounds bounds, double width, double height, double spacing)

static Layer createSquares(Map options, Bounds bounds, double length, double spacing)