Class Point

Point

Hierarchy

Point
- Point

Constructors

constructor

new Point(): Point
Returns Point
Inherited from MilPoint.constructor
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:23
new Point(point: Point): Point
Parameters
- point: Point
Returns Point
Inherited from MilPoint.constructor
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:24
new Point(x: number, y: number): Point
Parameters
- x: number
- y: number
Returns Point
Inherited from MilPoint.constructor
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:25
new Point(x: number, y: number, z: number): Point
Parameters
- x: number
- y: number
- z: number
Returns Point
Inherited from MilPoint.constructor
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:26
new Point(x: number, y: number, z: number, m: number): Point
Parameters
- x: number
- y: number
- z: number
- m: number
Returns Point
Inherited from MilPoint.constructor
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:27
new Point(hasZ: boolean, hasM: boolean, x: number, y: number): Point
Parameters
- hasZ: boolean
- hasM: boolean
- x: number
- y: number
Returns Point
Inherited from MilPoint.constructor
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:28

Accessors

geometryType

get geometryType(): GeometryType
Get the geometry type

Returns
geometry type

Returns GeometryType
Inherited from MilPoint.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 MilPoint.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 MilPoint.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 MilPoint.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 MilPoint.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 MilPoint.is3D
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:45

m

get m(): number
Get m

Returns
m

Returns number
Inherited from MilPoint.m
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:64
set m(m: number): void
Set m
Parameters
- m: number
Returns void
Inherited from MilPoint.m
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:69

x

get x(): number
Get x

Returns
x

Returns number
Inherited from MilPoint.x
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:33
set x(x: number): void
Set y
Parameters
- x: number
Returns void
Inherited from MilPoint.x
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:38

y

get y(): number
Get y

Returns
y

Returns number
Inherited from MilPoint.y
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:43
set y(y: number): void
Set y
Parameters
- y: number
Returns void
Inherited from MilPoint.y
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:48

z

get z(): number
Get z

Returns
z

Returns number
Inherited from MilPoint.z
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:53
set z(z: number): void
Set z
Parameters
- z: number
Returns void
Inherited from MilPoint.z
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:58

Methods

copy

copy(): Point
Copy the point

Returns
point copy

Returns Point
Overrides MilPoint.copy
- Defined in lib/features/Point.ts:290

equals

equals(other: Point): boolean
{@inheritDoc}
Parameters
- other: Point
Returns boolean
Overrides MilPoint.equals
- Defined in lib/features/Point.ts:299

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 MilPoint.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 MilPoint.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 MilPoint.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 MilPoint.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 MilPoint.getEnvelope
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:83

getLatitude

getLatitude(): number
Get the latitude

Returns
latitude

Returns number
- Defined in lib/features/Point.ts:162

getLongitude

getLongitude(): number
Get the longitude

Returns
longitude

Returns number
- Defined in lib/features/Point.ts:143

getPixel

getPixel(width: number, height: number, bounds: Bounds): Pixel
Get the pixel where the point fits into the bounds

Returns
pixel
Parameters
- width: number
  
  width
- height: number
  
  height
- bounds: Bounds
  
  bounds
Returns Pixel
- Defined in lib/features/Point.ts:281

getPixelFromTile

getPixelFromTile(tile: GridTile): Pixel
Get the pixel where the point fits into tile

Returns
pixel
Parameters
- tile: GridTile
  
  tile
Returns Pixel
- Defined in lib/features/Point.ts:266

getUnit

getUnit(): undefined | Unit
Get the unit

Returns
unit

Returns undefined | Unit
- Defined in lib/features/Point.ts:181

isDegrees

isDegrees(): boolean
Is this point in degrees

Returns
true if degrees

Returns boolean
- Defined in lib/features/Point.ts:211

isEmpty

isEmpty(): boolean
{@inheritDoc}

Returns boolean
Inherited from MilPoint.isEmpty
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:77

isMeasured

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

Returns
true if has m coordinates

See
#hasM()

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

isMeters

isMeters(): boolean
Is this point in meters

Returns
true if meters

Returns boolean
- Defined in lib/features/Point.ts:220

isSimple

isSimple(): boolean
{@inheritDoc}

Returns boolean
Inherited from MilPoint.isSimple
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Point.d.ts:81

isUnit

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

Returns
true if in the unit
Parameters
- Optional unit: Unit
  
  unit
Returns boolean
- Defined in lib/features/Point.ts:202

setLatitude

setLatitude(latitude: number): void
Set the latitude
Parameters
- latitude: number
  
  latitude
Returns void
- Defined in lib/features/Point.ts:172

setLongitude

setLongitude(longitude: number): void
Set the longitude
Parameters
- longitude: number
  
  longitude
Returns void
- Defined in lib/features/Point.ts:153

setUnit

setUnit(unit?: Unit): void
Set the unit
Parameters
- Optional unit: Unit
  
  unit
Returns void
- Defined in lib/features/Point.ts:191

toDegrees

toDegrees(): Point
Convert to degrees

Returns
point in degrees, same point if already in degrees

Returns Point
- Defined in lib/features/Point.ts:246

toMeters

toMeters(): Point
Convert to meters

Returns
point in meters, same point if already in meters

Returns Point
- Defined in lib/features/Point.ts:255

toUnit

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

Returns
point in units, same point if equal units
Parameters
- unit: Unit
  
  unit
Returns Point
- Defined in lib/features/Point.ts:231

updateZM

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

`Static` degrees

degrees(longitude: number, latitude: number): Point
Create a point in degrees

Returns
point in degrees
Parameters
- longitude: number
  
  longitude in degrees
- latitude: number
  
  latitude in degrees
Returns Point
- Defined in lib/features/Point.ts:48

`Static` degreesToMeters

degreesToMeters(longitude: number, latitude: number): Point
Create a point converting the degrees coordinate to meters

Returns
point in meters
Parameters
- longitude: number
  
  longitude in degrees
- latitude: number
  
  latitude in degrees
Returns Point
- Defined in lib/features/Point.ts:106

`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 MilPoint.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 MilPoint.hasZ
- Defined in node_modules/@ngageoint/simple-features-js/dist/lib/Geometry.d.ts:66

`Static` meters

meters(longitude: number, latitude: number): Point
Create a point in meters

Returns
point in meters
Parameters
- longitude: number
  
  longitude in meters
- latitude: number
  
  latitude in meters
Returns Point
- Defined in lib/features/Point.ts:61

`Static` metersToDegrees

metersToDegrees(longitude: number, latitude: number): Point
Create a point converting the meters coordinate to degrees

Returns
point in degrees
Parameters
- longitude: number
  
  longitude in meters
- latitude: number
  
  latitude in meters
Returns Point
- Defined in lib/features/Point.ts:119

`Static` point

point(longitude: number, latitude: number, unit?: Unit): Point
Create a point

Returns
point
Parameters
- longitude: number
  
  longitude
- latitude: number
  
  latitude
- Optional unit: Unit
  
  unit; if null, it will use the default degree unit
Returns Point
- Defined in lib/features/Point.ts:28

`Static` pointFromPoint

pointFromPoint(point: Point, unit?: Unit): Point
Create a point

Returns
point
Parameters
- point: Point
  
  point to copy
- Optional unit: Unit
  
  unit
Returns Point
- Defined in lib/features/Point.ts:132

`Static` toUnit

toUnit(fromUnit: Unit, longitude: number, latitude: number, toUnit: Unit): Point
Create a point from a coordinate in a unit to another unit

Returns
point in unit
Parameters
- fromUnit: Unit
  
  unit of provided coordinate
- longitude: number
  
  longitude
- latitude: number
  
  latitude
- toUnit: Unit
  
  desired unit
Returns Point
- Defined in lib/features/Point.ts:78

`Static` toUnitInverse

toUnitInverse(longitude: number, latitude: number, unit: Unit): Point
Create a point from a coordinate in an opposite unit to another unit

Returns
point in unit
Parameters
- longitude: number
  
  longitude
- latitude: number
  
  latitude
- unit: Unit
  
  desired unit
Returns Point
- Defined in lib/features/Point.ts:93

Class Point

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Point

Parameters

point: Point

Returns Point

Parameters

x: number

y: number

Returns Point

Parameters

x: number

y: number

z: number

Returns Point

Parameters

x: number

y: number

z: number

m: number

Returns Point

Parameters

hasZ: boolean

hasM: boolean

x: number

y: number

Returns Point

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

m

Returns

Returns number

Parameters

m: number

Returns void

x

Returns

Returns number

Parameters

x: number

Returns void

y

Returns

Returns number

Parameters

y: number

Returns void

z

Returns

Returns number

Parameters

z: number

Returns void

Methods

copy

Returns

`Optional` unit: Unit