Class GCS

Geodetic coordinate system.

Hierarchy-Diagram

UML class diagram of GCS

Legend

icon for a class in the UML class diagram

class

Hierarchy

Unit
- GCS

Index

Constructors

Properties

EARTH_ECCENTRICITY EARTH_EQUATORIAL_RADIUS EARTH_POLAR_RADIUS EARTH_RADIUS_MEAN ECEF EPSG3857 EPSG4326 UNITS UNIT_BASES UNKNOWN WGS84

Accessors

aliases baseName definitions name prefixType prefixes EARTH_RADIUS

Methods

convert createBaseDefinition createDefinition findByName specifier convert findByName fromJSON registerUnit

Constructors

constructor

new GCS(name?: string, options?: UnitOptions): GCS
Create a new unit
Parameters
- Optional name: string
  
  Unit name
- Optional options: UnitOptions
  
  Unit options
Returns GCS
Inherited from Unit.constructor
- Defined in src/utils/unit/Unit.ts:52

Properties

`Static` `Readonly` EARTH_ECCENTRICITY

EARTH_ECCENTRICITY: 0.081819190842622 = 8.1819190842622e-2

`Static` `Readonly` EARTH_EQUATORIAL_RADIUS

EARTH_EQUATORIAL_RADIUS: 6378137 = 6378137

`Static` `Readonly` EARTH_POLAR_RADIUS

EARTH_POLAR_RADIUS: 6356752.3142 = 6356752.3142

`Static` `Readonly` EARTH_RADIUS_MEAN

EARTH_RADIUS_MEAN: 6371008.7714 = 6371008.7714

`Static` `Readonly` ECEF

ECEF: GCS = ...

`Static` `Readonly` EPSG3857

EPSG3857: GCS = ...

`Static` `Readonly` EPSG4326

EPSG4326: GCS = ...

`Static` `Protected` `Readonly` UNITS

UNITS: Map<string, Unit> = ...

`Static` `Protected` `Readonly` UNIT_BASES

UNIT_BASES: Map<string, string> = ...

`Static` `Readonly` UNKNOWN

UNKNOWN: Unit = ...

`Static` `Readonly` WGS84

WGS84: GCS = GCS.EPSG4326

Accessors

aliases

get aliases(): string[]
Unit aliases

Returns
Alias names as array

Returns string[]
Inherited from Unit.aliases
- Defined in src/utils/unit/Unit.ts:161

baseName

get baseName(): string
Returns string
Inherited from Unit.baseName
- Defined in src/utils/unit/Unit.ts:165

definitions

get definitions(): UnitDefinition[]
Returns UnitDefinition[]
Inherited from Unit.definitions
- Defined in src/utils/unit/Unit.ts:173

name

get name(): string
Unit name

Returns
Name

Returns string
Inherited from Unit.name
- Defined in src/utils/unit/Unit.ts:140
set name(name: string): void
Parameters
- name: string
Returns void
Inherited from Unit.name
- Defined in src/utils/unit/Unit.ts:145

prefixType

get prefixType(): UnitPrefixType
Returns UnitPrefixType
Inherited from Unit.prefixType
- Defined in src/utils/unit/Unit.ts:169

`Protected` prefixes

get prefixes(): UnitPrefix[]
Returns UnitPrefix[]
Inherited from Unit.prefixes
- Defined in src/utils/unit/Unit.ts:177

`Static` EARTH_RADIUS

get EARTH_RADIUS(): number
Deprecated
Use GCS.EARTH_RADIUS_MEAN

Returns
Mean earth radius

Returns number
- Defined in src/utils/unit/GCS.ts:20

Methods

convert

convert<T>(value: T, target: string | Unit): T
Convert a value in the current unit to a target unit

Returns
Converted unit
Type Parameters
- T extends UnitValueType
Parameters
- value: T
  
  Value to convert
- target: string | Unit
  
  Target unit
Returns T
Inherited from Unit.convert
- Defined in src/utils/unit/Unit.ts:352

createBaseDefinition

createBaseDefinition(): UnitFunctionDefinition<any, any>
Get or create a definition from this unit to the base

Returns
Definition to base

Returns UnitFunctionDefinition<any, any>
Inherited from Unit.createBaseDefinition
- Defined in src/utils/unit/Unit.ts:191

createDefinition

createDefinition(targetUnit: Unit): UnitFunctionDefinition<any, any>
Parameters
- targetUnit: Unit
Returns UnitFunctionDefinition<any, any>
Inherited from Unit.createDefinition
- Defined in src/utils/unit/Unit.ts:218

`Protected` findByName

findByName(name: string): Unit
Find unit specifier by name or alias

Returns
Unit if found
Parameters
- name: string
  
  Unit name
Returns Unit
Inherited from Unit.findByName
- Defined in src/utils/unit/Unit.ts:298

specifier

specifier(prefix: UnitPrefix): GCS
Get the unit specifier

Returns
Unit with specifier
Parameters
- prefix: UnitPrefix
  
  Unit prefix
Returns GCS
Inherited from Unit.specifier
- Defined in src/utils/unit/Unit.ts:262

`Static` convert

convert<T>(value: T, from: string | Unit, to: string | Unit): T
Convert a value from a specific unit to a target unit

Returns
Converted unit
Type Parameters
- T extends UnitValueType
Parameters
- value: T
  
  Value to convert
- from: string | Unit
  
  Source unit
- to: string | Unit
  
  Target unit
Returns T
Inherited from Unit.convert
- Defined in src/utils/unit/Unit.ts:376

`Static` findByName

findByName(name: string, baseName?: string): Unit
Find a unit by its name

Returns
Unit if found
Parameters
- name: string
  
  Unit name
- Optional baseName: string
  
  Optional base name to specific result
Returns Unit
Inherited from Unit.findByName
- Defined in src/utils/unit/Unit.ts:324

`Static` fromJSON

fromJSON<T>(json: any): T
Get a unit from JSON

Returns
Unit if found
Type Parameters
- T extends Unit<T>
Parameters
- json: any
  
  JSON object
Returns T
Inherited from Unit.fromJSON
- Defined in src/utils/unit/Unit.ts:78

`Static` registerUnit

registerUnit(unit: Unit, override?: boolean): Unit
Register a new unit

Returns
Registered unit
Parameters
- unit: Unit
  
  Unit to register
- override: boolean = false
  
  Override an existing unit with the same name
Returns Unit
Inherited from Unit.registerUnit
- Defined in src/utils/unit/Unit.ts:388