Class Line

A LineString with exactly 2 Points.

Hierarchy

LineString
- Line

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Line(): Line
new Line(hasZ: boolean, hasM: boolean): Line
new Line(points: Array<Point>): Line
new Line(line: Line): Line
new Line(point1: Point, point2: Point): Line

Overrides LineString.constructor
- Defined in lib/Line.ts:6
Constructor Constructor Constructor

Returns Line
Overrides LineString.constructor
- Defined in lib/Line.ts:7
Constructor Constructor Constructor

Parameters
- hasZ: boolean
- hasM: boolean
Returns Line
Overrides LineString.constructor
- Defined in lib/Line.ts:8
Constructor Constructor Constructor

Parameters
- points: Array<Point>
Returns Line
Overrides LineString.constructor
- Defined in lib/Line.ts:9
Constructor Constructor Constructor

Parameters
- line: Line
Returns Line
Overrides LineString.constructor
- Defined in lib/Line.ts:10
Constructor

since

1.1.1

Parameters
- point1: Point
```
       first point
```
- point2: Point
```
       second point
```
Returns Line

Accessors

geometryType

get geometryType(): GeometryType

Inherited from Geometry.geometryType
- Defined in lib/Geometry.ts:39
Get the geometry type

Returns GeometryType

geometry type

hasM

get hasM(): boolean
set hasM(hasM: boolean): void

Inherited from Geometry.hasM
- Defined in lib/Geometry.ts:72
Does the geometry have m coordinates

Returns boolean

true if has m coordinates
Inherited from Geometry.hasM
- Defined in lib/Geometry.ts:80
Set if the geometry has m coordinates

Parameters
- hasM: boolean
  
  true if has m coordinates
Returns void

true if has m coordinates

hasZ

get hasZ(): boolean
set hasZ(hasZ: boolean): void

Inherited from Geometry.hasZ
- Defined in lib/Geometry.ts:47
Does the geometry have z coordinates

Returns boolean

true if has z coordinates
Inherited from Geometry.hasZ
- Defined in lib/Geometry.ts:55
Set if the geometry has z coordinates

Parameters
- hasZ: boolean
  
  true if has z coordinates
Returns void

true if has z coordinates

is3D

get is3D(): boolean

Inherited from Geometry.is3D
- Defined in lib/Geometry.ts:64
Does the geometry have z coordinates

see

#hasZ()

Returns boolean

true if has z coordinates

points

get points(): Array<Point>
set points(points: Array<Point>): void

Inherited from LineString.points
- Defined in lib/LineString.ts:45
Get the points

Returns Array<Point>

points
Inherited from LineString.points
- Defined in lib/LineString.ts:53
Set the points

Parameters
- points: Array<Point>
  
  points
Returns void

points

Methods

addPoint

addPoint(point: Point): void

Inherited from LineString.addPoint
- Defined in lib/LineString.ts:61
Add a point

Parameters
- point: Point
  
  point
Returns void

addPoints

addPoints(points: Array<Point>): void

Inherited from LineString.addPoints
- Defined in lib/LineString.ts:70
Add points

Parameters
- points: Array<Point>
  
  points
Returns void

copy

copy(): Geometry

Overrides LineString.copy
- Defined in lib/Line.ts:48
{@inheritDoc}

Returns Geometry

endPoint

endPoint(): Point

Inherited from LineString.endPoint

Overrides Curve.endPoint
- Defined in lib/LineString.ts:105
{@inheritDoc}

Returns Point

equals

equals(obj: Geometry): boolean

Inherited from LineString.equals

Overrides Curve.equals
- Defined in lib/LineString.ts:137
{@inheritDoc}

Parameters
- obj: Geometry
Returns boolean

expandEnvelope

expandEnvelope(envelope: GeometryEnvelope): void

Inherited from Geometry.expandEnvelope
- Defined in lib/Geometry.ts:150
Expand the envelope with the minimum bounding box for this Geometry

Parameters
- envelope: GeometryEnvelope
  
  geometry envelope to expand
Returns void

getCentroid

getCentroid(): Point

Inherited from Geometry.getCentroid
- Defined in lib/Geometry.ts:170
Get the mathematical centroid point of a 2 dimensional representation of the Geometry (balancing point of a 2d cutout of the geometry). Only the x and y coordinate of the resulting point are calculated and populated. The resulting {@link Point#getZ()} and {@link Point#getM()} methods will always return null.

Returns Point

centroid point

getDegreesCentroid

getDegreesCentroid(): Point

Inherited from Geometry.getDegreesCentroid
- Defined in lib/Geometry.ts:181
Get the geographic centroid point of a 2 dimensional representation of the degree unit Geometry. Only the x and y coordinate of the resulting point are calculated and populated. The resulting {@link Point#getZ()} and {@link Point#getM()} methods will always return null.

Returns Point

centroid point

getDimension

getDimension(): number

Inherited from Geometry.getDimension
- Defined in lib/Geometry.ts:158
Get the inherent dimension (0, 1, or 2) for this Geometry

Returns number

dimension

getEnvelope

getEnvelope(): GeometryEnvelope

Inherited from Geometry.getEnvelope
- Defined in lib/Geometry.ts:142
Get the minimum bounding box for this Geometry

Returns GeometryEnvelope

geometry envelope

getPoint

getPoint(n: number): Point

Inherited from LineString.getPoint
- Defined in lib/LineString.ts:87
Returns the Nth point

Parameters
- n: number
  
  nth point to return
Returns Point

point

isClosed

isClosed(): boolean

Inherited from Curve.isClosed
- Defined in lib/Curve.ts:39
Determine if this Curve is closed (start point = end point)

Returns boolean

true if closed

isEmpty

isEmpty(): boolean

Inherited from LineString.isEmpty

Overrides Geometry.isEmpty
- Defined in lib/LineString.ts:130
{@inheritDoc}

Returns boolean

isMeasured

isMeasured(): boolean

Inherited from Geometry.isMeasured
- Defined in lib/Geometry.ts:134
Does the geometry have m coordinates.

see

#hasM()

Returns boolean

true if has m coordinates

isSimple

isSimple(): boolean

Inherited from LineString.isSimple

Overrides Geometry.isSimple
- Defined in lib/LineString.ts:116
{@inheritDoc}

Returns boolean

numPoints

numPoints(): number

Inherited from LineString.numPoints
- Defined in lib/LineString.ts:78
Get the number of points

Returns number

number of points

startPoint

startPoint(): Point

Inherited from LineString.startPoint

Overrides Curve.startPoint
- Defined in lib/LineString.ts:94
{@inheritDoc}

Returns Point

updateZM

updateZM(geometry: Geometry): void

Inherited from Geometry.updateZM
- Defined in lib/Geometry.ts:88
Update currently false hasZ and hasM values using the provided geometry

Parameters
- geometry: Geometry
  
  geometry
Returns void

Static hasM

hasM(geometries: Array<Geometry>): boolean

Inherited from Geometry.hasM
- Defined in lib/Geometry.ts:118
Determine if the geometries contain a M value

Parameters
- geometries: Array<Geometry>
  
  list of geometries
Returns boolean

true if has m

Static hasZ

hasZ(geometries: Array<Geometry>): boolean

Inherited from Geometry.hasZ
- Defined in lib/Geometry.ts:102
Determine if the geometries contain a Z value

Parameters
- geometries: Array<Geometry>
  
  list of geometries
Returns boolean

true if has z

Generated using TypeDoc