Skip to main content

Class: NextGenNearestMapBuilder

Constructors

constructor

new NextGenNearestMapBuilder(): NextGenNearestMapBuilder

Returns

NextGenNearestMapBuilder

Methods

build

build<MapBuilder>(mapBuilder, options): MapBuilder

Configures a map builder to generate a next-generation (NXi, G3000, etc) Garmin nearest waypoint map.

The module [GarminMapKeys.WaypointHighlight]: MapWaypointHighlightModule is added to the map model and can be used to control the highlighted waypoint.

The controller [GarminMapKeys.Range]: MapRangeController is added to the map context and can be used to control the range of the map.

If the map pointer is supported, the controller [GarminMapKeys.Pointer]: MapPointerController is added to the map context and can be used to control the pointer.

The map builder will not be configured to apply a custom projected size, dead zone, or to automatically update the map.

Type parameters

NameType
MapBuilderextends MapSystemBuilder<any, any, any, any>

Parameters

NameTypeDescription
mapBuilderMapBuilderThe map builder to configure.
optionsNextGenNearestMapOptionsOptions for configuring the map.

Returns

MapBuilder

The builder, after it has been configured.

Defined in

src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:339