LineString (Groovy Documentation)

geoscript.geom.LineString

class LineString
extends Geometry

A LineString Geometry.

You can create a LineString from a List of List of Doubles or a List of Points.

 LineString line = new LineString([[1,2],[3,4],[4,5]])
 LineString line = new LineString([new Point(111.0, -47), new Point(123.0, -48), new Point(110.0, -47)])

Or you an create a LineString from a repeated List of Doubles.

 LineString line = new LineString([1,2],[3,4],[4,5])

Or you can create a LineString from a List of repeated Points.

 LineString line = new LineString(new Point(1,2), new Point(3,4), new Point(4,5))

Authors:: Jared Erickson

Constructor Summary

Constructors
Constructor and description
`LineString(LineString line)` Create a LineString from a JTS LineString.
`LineString(java.util.List coordinates)` Create a LineString from a List of List of Doubles or a List of Points.
`LineString(java.util.List<java.lang.Double>[] coordinates)` Create a LineString from a repeated List of Doubles.
`LineString(java.awt.Point[] points)` Create a LineString from a List of repeated Points.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`LineString`	`addPoint(int index, Point pt)` Add a Point at the given index
	`LinearRing`	`close()` Close a LineString to create a LinearRing
	`MultiPoint`	`createPointsAlong(double distance)` Create Points along the LineString with the given interval distance.
	`Point`	`getEndPoint()` Get the end Point
	`Point`	`getStartPoint()` Get the start Point
	`Point`	`interpolatePoint(double position)` Interpolate a Point on this LineString at the given position from 0 to 1.
	`boolean`	`isClosed()` Is this LineString closed?
	`boolean`	`isRing()` Is this LineString a ring?
	`double`	`locatePoint(Point point)` Locate the position of the Point along this LineString.
	`LineString`	`negative()` Remove the last Point from this LineString to create a new LineString
	`Point`	`placePoint(Point point)` Place the Point on the LineString
	`MultiLineString`	`plus(LineString line)` Add this LineString with another to create a MultiLineString
	`LineString`	`plus(Point point)` Add a Point to the end of this LineString
	`LineString`	`removePoint(int index)` Remove the Point at the given index and create a new LineString
	`LineString`	`reverse()` Create a new LineString where the coordinates are in reverse order
	`LineString`	`setPoint(int index, Point pt)` Set or replace the Point at the given index to create a new LineString
	`LineString`	`subLine(double start, double end)` Extract a sub LineString from this LineString from the start and end positions.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Geometry`	asType, buffer, cascadedUnion, concaveHull, concaveHullOfPolygons, contains, coveredBy, covers, createFromText, createKochSnowflake, createRandomPoints, createRandomPointsInGrid, createSierpinskiCarpet, crosses, densify, difference, disjoint, distance, equals, equalsNorm, equalsTopo, fix, fromString, getArea, getAt, getBoundary, getBounds, getCentroid, getConvexHull, getCoordinates, getDelaunayTriangleDiagram, getDimension, getEnvelope, getEnvelopeInternal, getGeometries, getGeometryN, getGeometryType, getInteriorPoint, getLargestEmptyCircle, getLength, getMaximumInscribedCircle, getMinimumBoundingCircle, getMinimumClearance, getMinimumDiameter, getMinimumRectangle, getNearestPoints, getNorm, getNumGeometries, getNumPoints, getOctagonalEnvelope, getPoints, getValidReason, getVoronoiDiagram, hashCode, intersection, intersects, isCurved, isEmpty, isRectangle, isSimple, isValid, isWithinDistance, normalize, offset, offsetCurve, overlaps, prepare, prepare, reducePrecision, reflect, reflect, relate, relate, rotate, rotate, rotate, rotate, scale, scale, shear, simplify, simplifyPreservingTopology, singleSidedBuffer, smooth, snap, symDifference, toString, touches, translate, triangulate, union, union, variableBuffer, within, wrap

- Constructor Detail
  - LineString(LineString line)
    
    Create a LineString from a JTS LineString.
```
 LineString line = new LineString(jtsLineString)
 
```
    Parameters:
    line - The JTS LineString
  - LineString(java.util.List coordinates)
    
    Create a LineString from a List of List of Doubles or a List of Points.
```
 LineString line = new LineString([[1,2],[3,4],[4,5]])
 LineString line = new LineString([new Point(111.0, -47), new Point(123.0, -48), new Point(110.0, -47)])
 
```
    Parameters:
    coordinates - A List of Coordinates as a List of List of Doubles or a List of Points
  - LineString(java.util.List<java.lang.Double>[] coordinates)
    
    Create a LineString from a repeated List of Doubles.
```
 LineString line = new LineString([1,2],[3,4],[4,5])
 
```
    Parameters:
    coordinates - A repeated of List of Doubles.
  - LineString(java.awt.Point[] points)
    
    Create a LineString from a List of repeated Points.
```
 LineString line = new LineString(new Point(1,2), new Point(3,4), new Point(4,5))
 
```
    Parameters:
    points - A List of repated Points
- Method Detail
  - LineString addPoint(int index, Point pt)
    
    Add a Point at the given index
    Parameters:
    index - The index where to insert the Point
    pt - The Point to add
    Returns:
    A new LineString
  - LinearRing close()
    
    Close a LineString to create a LinearRing
    Returns:
    A LinearRing
  - MultiPoint createPointsAlong(double distance)
    
    Create Points along the LineString with the given interval distance.
    Parameters:
    distance - The interval distance of distance between points.
    Returns:
    A MultiPoint
  - Point getEndPoint()
    
    Get the end Point
    Returns:
    The end Point
  - Point getStartPoint()
    
    Get the start Point
    Returns:
    The start Point
  - Point interpolatePoint(double position)
    
    Interpolate a Point on this LineString at the given position from 0 to 1.
    Parameters:
    position - The position along the LineString from 0 to 1
    Returns:
    A Point on this LineString
  - boolean isClosed()
    
    Is this LineString closed?
    Returns:
    Whether this LineString is closed
  - boolean isRing()
    
    Is this LineString a ring?
    Returns:
    Whether this LineString is a ring
  - double locatePoint(Point point)
    
    Locate the position of the Point along this LineString.
    Parameters:
    point - The Point
    Returns:
    The position of the Point along this LineString.
  - LineString negative()
    
    Remove the last Point from this LineString to create a new LineString
    Returns:
    A new LineString
  - Point placePoint(Point point)
    
    Place the Point on the LineString
    Parameters:
    point - The Point
    Returns:
    A new Point on the LineString
  - MultiLineString plus(LineString line)
    
    Add this LineString with another to create a MultiLineString
    Parameters:
    line - Another LineString
    Returns:
    A new MultiLineString
  - LineString plus(Point point)
    
    Add a Point to the end of this LineString
    Parameters:
    point - The Point
    Returns:
    The new LineString
  - LineString removePoint(int index)
    
    Remove the Point at the given index and create a new LineString
    Parameters:
    index - The index of the Point to remove
    Returns:
    The new LineString
  - LineString reverse()
    
    Create a new LineString where the coordinates are in reverse order
    Returns:
    A LineString
  - LineString setPoint(int index, Point pt)
    
    Set or replace the Point at the given index to create a new LineString
    Parameters:
    index - The index of the Point we want to replace
    pt - The new Point
    Returns:
    The new LineString
  - LineString subLine(double start, double end)
    
    Extract a sub LineString from this LineString from the start and end positions.
    Parameters:
    start - The start position.
    end - The end position.
    Returns:
    A sub LineString

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class LineString

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

LineString(LineString line)

LineString(java.util.List coordinates)

LineString(java.util.List<java.lang.Double>[] coordinates)

LineString(java.awt.Point[] points)

Method Detail

LineString addPoint(int index, Point pt)

LinearRing close()

MultiPoint createPointsAlong(double distance)

Point getEndPoint()

Point getStartPoint()

Point interpolatePoint(double position)

boolean isClosed()

boolean isRing()

double locatePoint(Point point)

LineString negative()

Point placePoint(Point point)

MultiLineString plus(LineString line)

LineString plus(Point point)

LineString removePoint(int index)

LineString reverse()

LineString setPoint(int index, Point pt)

LineString subLine(double start, double end)