Class GridLine

Line between two points

Hierarchy

Line
- GridLine

Constructors

constructor

new GridLine(): GridLine
Returns GridLine
Inherited from Line.constructor
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Line.d.ts:6
new GridLine(hasZ: boolean, hasM: boolean): GridLine
Parameters
- hasZ: boolean
- hasM: boolean
Returns GridLine
Inherited from Line.constructor
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Line.d.ts:7
new GridLine(points: Point[]): GridLine
Parameters
- points: Point[]
Returns GridLine
Inherited from Line.constructor
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Line.d.ts:8
new GridLine(line: Line): GridLine
Parameters
- line: Line
Returns GridLine
Inherited from Line.constructor
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Line.d.ts:9
new GridLine(point1: Point, point2: Point): GridLine
Constructor

Since
1.1.1
Parameters
- point1: Point
  
  first point
- point2: Point
  
  second point
Returns GridLine
Inherited from Line.constructor
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Line.d.ts:19

Accessors

geometryType

get geometryType(): GeometryType
Get the geometry type

Returns
geometry type

Returns GeometryType
Inherited from Line.geometryType
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:29

hasM

get hasM(): boolean
Does the geometry have m coordinates

Returns
true if has m coordinates

Returns boolean
Inherited from Line.hasM
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:50
set hasM(hasM: boolean): void
Set if the geometry has m coordinates
Parameters
- hasM: boolean
  
  true if has m coordinates
Returns void
Inherited from Line.hasM
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:55

hasZ

get hasZ(): boolean
Does the geometry have z coordinates

Returns
true if has z coordinates

Returns boolean
Inherited from Line.hasZ
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:34
set hasZ(hasZ: boolean): void
Set if the geometry has z coordinates
Parameters
- hasZ: boolean
  
  true if has z coordinates
Returns void
Inherited from Line.hasZ
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:39

is3D

get is3D(): boolean
Does the geometry have z coordinates

Returns
true if has z coordinates

See
#hasZ()

Returns boolean
Inherited from Line.is3D
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:45

points

get points(): Point[]
Get the points

Returns
points

Returns Point[]
Inherited from Line.points
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/LineString.d.ts:19
set points(points: Point[]): void
Set the points
Parameters
- points: Point[]
  
  points
Returns void
Inherited from Line.points
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/LineString.d.ts:24

Methods

addPoint

addPoint(point: Point): void
Add a point
Parameters
- point: Point
  
  point
Returns void
Inherited from Line.addPoint
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/LineString.d.ts:29

addPoints

addPoints(points: Point[]): void
Add points
Parameters
- points: Point[]
  
  points
Returns void
Inherited from Line.addPoints
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/LineString.d.ts:34

copy

copy(): GridLine
Copy the line

Returns
line copy

Returns GridLine
Overrides Line.copy
- Defined in lib/features/GridLine.ts:84

endPoint

endPoint(): Point
{@inheritDoc}

Returns Point
Inherited from Line.endPoint
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/LineString.d.ts:53

equals

equals(obj: any): boolean
{@inheritDoc}
Parameters
- obj: any
Returns boolean
Overrides Line.equals
- Defined in lib/features/GridLine.ts:93

expandEnvelope

expandEnvelope(envelope: GeometryEnvelope): void
Expand the envelope with the minimum bounding box for this Geometry
Parameters
- envelope: GeometryEnvelope
  
  geometry envelope to expand
Returns void
Inherited from Line.expandEnvelope
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:88

getCentroid

getCentroid(): Point
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 Point#getZ() and Point#getM() methods will always return null.

Returns
centroid point

Returns Point
Inherited from Line.getCentroid
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:102

getDegreesCentroid

getDegreesCentroid(): Point
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 Point#getZ() and Point#getM() methods will always return null.

Returns
centroid point

Returns Point
Inherited from Line.getDegreesCentroid
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:110

getDimension

getDimension(): number
Get the inherent dimension (0, 1, or 2) for this Geometry

Returns
dimension

Returns number
Inherited from Line.getDimension
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:93

getEnvelope

getEnvelope(): GeometryEnvelope
Get the minimum bounding box for this Geometry

Returns
geometry envelope

Returns GeometryEnvelope
Inherited from Line.getEnvelope
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:83

getGridType

getGridType(): undefined | GridType
Get the line grid type

Returns
grid type

Returns undefined | GridType
- Defined in lib/features/GridLine.ts:56

getPoint

getPoint(n: number): Point
Returns the Nth point

Returns
point
Parameters
- n: number
  
  nth point to return
Returns Point
Inherited from Line.getPoint
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/LineString.d.ts:45

getPoint1

getPoint1(): Point
Get the first point

Returns
first point

Returns Point
Inherited from Line.getPoint1
- Defined in node_modules/@ngageoint/grid-js/dist/lib/features/Line.d.ts:23

getPoint2

getPoint2(): Point
Get the second point

Returns
second point

Returns Point
Inherited from Line.getPoint2
- Defined in node_modules/@ngageoint/grid-js/dist/lib/features/Line.d.ts:36

getUnit

getUnit(): undefined | Unit
Get the unit

Returns
unit

Returns undefined | Unit
Inherited from Line.getUnit
- Defined in node_modules/@ngageoint/grid-js/dist/lib/features/Line.d.ts:58

hasGridType

hasGridType(): boolean
Check if the line has a grid type

Returns
true if has grid type

Returns boolean
- Defined in lib/features/GridLine.ts:65

intersection

intersection(line: Line): undefined | Point
Get the intersection between this line and the provided line

Returns
intersection
Parameters
- line: Line
  
  line
Returns undefined | Point
Inherited from Line.intersection
- Defined in node_modules/@ngageoint/grid-js/dist/lib/features/Line.d.ts:106

isClosed

isClosed(): boolean
Determine if this Curve is closed (start point = end point)

Returns
true if closed

Returns boolean
Inherited from Line.isClosed
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Curve.d.ts:33

isDegrees

isDegrees(): boolean
Is this line in degrees

Returns
true if degrees

Returns boolean
Inherited from Line.isDegrees
- Defined in node_modules/@ngageoint/grid-js/dist/lib/features/Line.d.ts:72

isEmpty

isEmpty(): boolean
{@inheritDoc}

Returns boolean
Inherited from Line.isEmpty
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/LineString.d.ts:65

isMeasured

isMeasured(): boolean
Does the geometry have m coordinates.

Returns
true if has m coordinates

See
#hasM()

Returns boolean
Inherited from Line.isMeasured
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:78

isMeters

isMeters(): boolean
Is this line in meters

Returns
true if meters

Returns boolean
Inherited from Line.isMeters
- Defined in node_modules/@ngageoint/grid-js/dist/lib/features/Line.d.ts:78

isSimple

isSimple(): boolean
{@inheritDoc}

Returns boolean
Inherited from Line.isSimple
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/LineString.d.ts:57

isUnit

isUnit(unit: Unit): boolean
Is in the provided unit type

Returns
true if in the unit
Parameters
- unit: Unit
  
  unit
Returns boolean
Inherited from Line.isUnit
- Defined in node_modules/@ngageoint/grid-js/dist/lib/features/Line.d.ts:66

numPoints

numPoints(): number
Get the number of points

Returns
number of points

Returns number
Inherited from Line.numPoints
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/LineString.d.ts:39

setGridType

setGridType(gridType?: GridType): void
Set the line grid type
Parameters
- Optional gridType: GridType
  
  grid type
Returns void
- Defined in lib/features/GridLine.ts:75

setPoint1

setPoint1(point1: Point): void
Set the first point
Parameters
- point1: Point
  
  first point
Returns void
Inherited from Line.setPoint1
- Defined in node_modules/@ngageoint/grid-js/dist/lib/features/Line.d.ts:30

setPoint2

setPoint2(point2: Point): void
Set the second point
Parameters
- point2: Point
  
  second point
Returns void
Inherited from Line.setPoint2
- Defined in node_modules/@ngageoint/grid-js/dist/lib/features/Line.d.ts:43

setPoints

setPoints(point1: Point, point2: Point): void
Set the points
Parameters
- point1: Point
  
  first point
- point2: Point
  
  second point
Returns void
Inherited from Line.setPoints
- Defined in node_modules/@ngageoint/grid-js/dist/lib/features/Line.d.ts:52

startPoint

startPoint(): Point
{@inheritDoc}

Returns Point
Inherited from Line.startPoint
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/LineString.d.ts:49

toDegrees

toDegrees(): Line
Convert to degrees

Returns
line in degrees, same line if already in degrees

Returns Line
Inherited from Line.toDegrees
- Defined in node_modules/@ngageoint/grid-js/dist/lib/features/Line.d.ts:92

toMeters

toMeters(): Line
Convert to meters

Returns
line in meters, same line if already in meters

Returns Line
Inherited from Line.toMeters
- Defined in node_modules/@ngageoint/grid-js/dist/lib/features/Line.d.ts:98

toUnit

toUnit(unit: Unit): Line
Convert to the unit

Returns
point in units, same point if equal units
Parameters
- unit: Unit
  
  unit
Returns Line
Inherited from Line.toUnit
- Defined in node_modules/@ngageoint/grid-js/dist/lib/features/Line.d.ts:86

updateZM

updateZM(geometry: Geometry): void
Update currently false hasZ and hasM values using the provided geometry
Parameters
- geometry: Geometry
  
  geometry
Returns void
Inherited from Line.updateZM
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:60

`Static` hasM

hasM(geometries: Geometry[]): boolean
Determine if the geometries contain a M value

Returns
true if has m
Parameters
- geometries: Geometry[]
  
  list of geometries
Returns boolean
Inherited from Line.hasM
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:72

`Static` hasZ

hasZ(geometries: Geometry[]): boolean
Determine if the geometries contain a Z value

Returns
true if has z
Parameters
- geometries: Geometry[]
  
  list of geometries
Returns boolean
Inherited from Line.hasZ
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:66

`Static` line

line(point1: Point, point2: Point, gridType?: GridType): GridLine
Create a line

Returns
line
Parameters
- point1: Point
  
  first point
- point2: Point
  
  second point
- Optional gridType: GridType
  
  line grid type (optional)
Returns GridLine
Overrides Line.line
- Defined in lib/features/GridLine.ts:24

`Static` lineFromLine

lineFromLine(line: Line, gridType?: GridType): GridLine
Create a line

Returns
line
Parameters
- line: Line
  
  line to copy
- Optional gridType: GridType
  
  line grid type (optional)
Returns GridLine
- Defined in lib/features/GridLine.ts:40

Class GridLine

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns GridLine

Parameters

hasZ: boolean

hasM: boolean

Returns GridLine

Parameters

points: Point[]

Returns GridLine

Parameters

line: Line

Returns GridLine

Since

Parameters

point1: Point

point2: Point

Returns GridLine

Accessors

geometryType

Returns

Returns GeometryType

hasM

Returns

Returns boolean

Parameters

hasM: boolean

Returns void

hasZ

Returns

Returns boolean

Parameters

hasZ: boolean

Returns void

is3D

Returns

See

Returns boolean

points

Returns

Returns Point[]

Parameters

points: Point[]

Returns void

Methods

addPoint

Parameters

point: Point

Returns void

addPoints

Parameters

points: Point[]

Returns void

copy

Returns

Returns GridLine

endPoint

Returns Point

equals

Parameters

obj: any

Returns boolean

expandEnvelope

Parameters

envelope: GeometryEnvelope

Returns void

getCentroid

Returns

Returns Point

getDegreesCentroid

Returns

Returns Point

getDimension

Returns

`Optional` gridType: GridType