Skip to main content

Class: DmsFormatter

Defined in: src/sdk/graphics/text/DmsFormatter.ts:24

A class to format latitude/longitude to DMS. DmsFormatter

Constructors

Constructor

new DmsFormatter(): DmsFormatter

Returns

DmsFormatter

Methods

getLatDmsStr()

getLatDmsStr(value, spaceAfterDirection, minuteApostrophe, precision, padMinutesTo): string

Defined in: src/sdk/graphics/text/DmsFormatter.ts:42

Builds a DMS string out of the given latitude.

Parameters

ParameterTypeDefault valueDescription
valuenumberundefinedThe latitude.
spaceAfterDirectionbooleantrueWhether to insert a space after the direction letter.
minuteApostrophebooleantrueWhether to insert an apostrophe (') after the string.
precisionnumber2Decimal precision for the minutes part.
padMinutesTonumber3Padding applied to integer part of minutes.

Returns

string

The DMS string.


getLonDmsStr()

getLonDmsStr(value, minuteApostrophe, precision, padMinutesTo): string

Defined in: src/sdk/graphics/text/DmsFormatter.ts:59

Builds a DMS string out of the given longitude.

Parameters

ParameterTypeDefault valueDescription
valuenumberundefinedThe longitude.
minuteApostrophebooleantrueWhether to insert an apostrophe (') after the string.
precisionnumber2Decimal precision for the minutes part.
padMinutesTonumber3Padding applied to integer part of minutes.

Returns

string

The DMS string.


parseLat()

parseLat(value): DmsValues

Defined in: src/sdk/graphics/text/DmsFormatter.ts:73

Parses a latitude in to the dms parts.

Parameters

ParameterTypeDescription
valuenumberThe latitude in degrees.

Returns

DmsValues

The DMS parts.


parseLon()

parseLon(value): DmsValues

Defined in: src/sdk/graphics/text/DmsFormatter.ts:83

Parses a longitude in to the dms parts.

Parameters

ParameterTypeDescription
valuenumberThe longitude in degrees.

Returns

DmsValues

The DMS parts.