Skip to main content

Class: MapUtils

Provides utility functions for working with Garmin maps.

Constructors

constructor

new MapUtils(): MapUtils

Returns

MapUtils

Methods

absoluteTerrainEarthColors

absoluteTerrainEarthColors(): Readonly<MapTerrainColorsDefinition>

Gets the earth colors definition for absolute terrain colors.

Returns

Readonly<MapTerrainColorsDefinition>

The earth colors definition for absolute terrain colors.

Defined in

src/garminsdk/components/map/MapUtils.ts:810


connextPrecipRadarColors

connextPrecipRadarColors(): readonly readonly [number, number][]

Gets the weather color array for the Connext precipitation radar overlay.

Returns

readonly readonly [number, number][]

The weather color array for the Connext precipitation radar overlay.

Defined in

src/garminsdk/components/map/MapUtils.ts:845


groundTerrainEarthColors

groundTerrainEarthColors(): Readonly<MapTerrainColorsDefinition>

Gets the earth colors definition for on ground relative terrain colors.

Returns

Readonly<MapTerrainColorsDefinition>

The earth colors definition for on ground relative terrain colors.

Defined in

src/garminsdk/components/map/MapUtils.ts:826


nextGenMapRanges

nextGenMapRanges(units): readonly NumberUnitReadOnly<Distance, Unit<Distance>>[]

Gets the standard map range array for next-generation (NXi, G3000, etc) avionics units.

Parameters

NameTypeDescription
unitsUnitsDistanceSettingModeThe distance units mode for which to get the array.

Returns

readonly NumberUnitReadOnly<Distance, Unit<Distance>>[]

The standard map range array for next-generation (NXi, G3000, etc) avionics units.

Defined in

src/garminsdk/components/map/MapUtils.ts:122


nextGenTrafficMapRanges

nextGenTrafficMapRanges(): readonly NumberUnitReadOnly<Distance, Unit<Distance>>[]

Gets the standard traffic map range array for next-generation (NXi, G3000, etc) avionics units.

Returns

readonly NumberUnitReadOnly<Distance, Unit<Distance>>[]

The standard traffic map range array for next-generation (NXi, G3000, etc) avionics units.

Defined in

src/garminsdk/components/map/MapUtils.ts:130


noTerrainEarthColors

noTerrainEarthColors(): Readonly<MapTerrainColorsDefinition>

Gets the earth colors definition for no terrain colors.

Returns

Readonly<MapTerrainColorsDefinition>

The earth colors definition for no terrain colors.

Defined in

src/garminsdk/components/map/MapUtils.ts:802


relativeTerrainEarthColors

relativeTerrainEarthColors(): Readonly<MapTerrainColorsDefinition>

Gets the earth colors definition for relative terrain colors.

Returns

Readonly<MapTerrainColorsDefinition>

The earth colors definition for relative terrain colors.

Defined in

src/garminsdk/components/map/MapUtils.ts:818