Class: NextGenNearestMapBuilder
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:320
Constructors
Constructor
new NextGenNearestMapBuilder():
NextGenNearestMapBuilder
Returns
NextGenNearestMapBuilder
Methods
build()
staticbuild<MapBuilder>(mapBuilder,options):MapBuilder
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:339
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
| Type Parameter |
|---|
MapBuilder extends MapSystemBuilder<any, any, any, any> |
Parameters
| Parameter | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | NextGenNearestMapOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.