Class: MapUtils

Defined in: src/garminsdk/components/map/MapUtils.ts:9

Provides utility functions for working with Garmin maps.

Constructors

Constructor

new MapUtils(): MapUtils

Returns

MapUtils

Methods

absoluteTerrainEarthColors()

static absoluteTerrainEarthColors(): Readonly<MapTerrainColorsDefinition>

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

Gets the earth colors definition for absolute terrain colors.

Returns

Readonly<MapTerrainColorsDefinition>

The earth colors definition for absolute terrain colors.

---

connextPrecipRadarColors()

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

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

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.

---

groundTerrainEarthColors()

static groundTerrainEarthColors(): Readonly<MapTerrainColorsDefinition>

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

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

Returns

Readonly<MapTerrainColorsDefinition>

The earth colors definition for on ground relative terrain colors.

---

nextGenMapRanges()

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

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

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

Parameters

Parameter	Type	Description
units	UnitsDistanceSettingMode	The 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.

---

nextGenTrafficMapRanges()

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

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

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.

---

noTerrainEarthColors()

static noTerrainEarthColors(): Readonly<MapTerrainColorsDefinition>

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

Gets the earth colors definition for no terrain colors.

Returns

Readonly<MapTerrainColorsDefinition>

The earth colors definition for no terrain colors.

---

relativeTerrainEarthColors()

static relativeTerrainEarthColors(): Readonly<MapTerrainColorsDefinition>

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

Gets the earth colors definition for relative terrain colors.

Returns

Readonly<MapTerrainColorsDefinition>

The earth colors definition for relative terrain colors.