Class: NextGenGarminMapBuilder

A builder for next-generation (NXi, G3000, etc) Garmin maps.

Constructors

constructor

• new NextGenGarminMapBuilder(): NextGenGarminMapBuilder

Returns

NextGenGarminMapBuilder

Methods

waypoints

▸ waypoints<MapBuilder>(mapBuilder, configure, supportRunwayOutlines, settingManager?, order?): MapBuilder

Configures a map builder to generate a map which supports the display of waypoints located within the boundaries of the map's projected window. Waypoints displayed in this manner are rendered by a MapWaypointRenderer under the role MapWaypointRenderRole.Normal. Optionally binds the visibility of waypoints to user settings.

If a text layer has already been added to the builder, its order will be changed so that it is rendered above the waypoint layer. Otherwise, a text layer will be added to the builder after the waypoint layer.

Adds the following...

Context properties:

• [MapSystemKeys.TextManager]: MapCullableTextLabelManager
• [MapSystemKeys.WaypointRenderer]: MapWaypointRenderer
• [GarminMapKeys.WaypointDisplayBuilder]: MapWaypointDisplayBuilder

Modules:

• [MapSystemKeys.NearestWaypoints]: MapWaypointsModule
• [GarminMapKeys.Range]: MapIndexedRangeModule (only if user settings are supported)

Layers:

• [MapSystemKeys.NearestWaypoints]: MapWaypointsLayer
• [MapSystemKeys.TextLayer]: MapCullableTextLayer

Controllers:

• [MapSystemKeys.WaypointRenderer]: MapSystemCustomController (handles initialization and updating of the waypoint renderer)
• [GarminMapKeys.WaypointsVisibility]: MapWaypointsVisController (only if user settings are supported)
• [GarminMapKeys.RunwayVisibility]: MapSymbolVisController (only if runway outlines are supported)
• [GarminMapKeys.RunwayLabelVisibility]: MapSymbolVisController (only if runway outlines are supported)

Type parameters

Name	Type
MapBuilder	extends MapSystemBuilder<any, any, any, any>

Parameters

Name	Type	Description
mapBuilder	MapBuilder	The map builder to configure.
configure	(builder: MapWaypointDisplayBuilder, context: MapSystemContext<any, any, any, any>) => void	A function used to configure the display and styling of waypoint icons and labels.
supportRunwayOutlines	boolean	Whether to support the rendering of airport runway outlines.
settingManager?	UserSettingManager<Partial<MapWaypointVisUserSettings>>	A setting manager containing the user settings controlling waypoint visibility. If not defined, waypoint visibility will not be bound to user settings.
order?	number	The order to assign to the waypoint layer. Layers with lower assigned order will be attached to the map before and appear below layers with greater assigned order values. Defaults to the number of layers already added to the map builder.

Returns

MapBuilder

The map builder, after it has been configured.

Defined in

src/garminsdk/components/map/NextGenGarminMapBuilder.tsx:56