Class Coordinate

Class Coordinate defines a spatial coordinate. It has a coordinate reference system (CRS) and can be 2D or 3D.

Index

Constructors

Properties

Methods

asWKT copy toString fromXY fromXYZ join

Constructors

constructor

new Coordinate(
    crs: string,
    x: number,
    y: number,
    z: number,
    is3D: boolean,
): Coordinate
Create a new coordinate.
Parameters
- crs: string
  the EPSG CRS code, like "4326" for example.
- x: number
  the X value.
- y: number
  the Y value.
- z: number
  the Z value.
- is3D: boolean
  does the coordinate have a valid Z value?
Returns Coordinate

Properties

crs

crs: string

The EPSG CRS code, like "4326" for example

is3D

is3D: boolean

Does the coordinate have a valid Z value?

x

x: number

The X value

y

y: number

The Y value

z

z: number

The Z value

Methods

asWKT

asWKT(): string
Convert to a WKT string.

Returns string
a WKT string.

copy

copy(): Coordinate
Make a copy of this coordinate.

Returns Coordinate

toString

toString(): string
Convert the object to a string.

Returns string
the string form of the object.

`Static`fromXY

fromXY(crs: string, x: number, y: number): Coordinate
Create a new 2D coordinate.
Parameters
- crs: string
  the EPSG CRS code, like "4326" for example.
- x: number
  the X value.
- y: number
  the Y value.
Returns Coordinate
the coordinate.

`Static`fromXYZ

fromXYZ(crs: string, x: number, y: number, z: number): Coordinate
Create a new 3D coordinate.
Parameters
- crs: string
  the EPSG CRS code, like "4326" for example.
- x: number
  the X value.
- y: number
  the Y value.
- z: number
  the Z value.
Returns Coordinate
the coordinate.

`Static`join

join(coordinates: AList<Coordinate>): string
Join a list of coordinates into a string.
Parameters
- coordinates: AList<Coordinate>
  the list of coordinates.
Returns string
the string.