Class: TrafficMapBuilder
Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:231
Builds Garmin traffic maps.
Constructors
Constructor
new TrafficMapBuilder():
TrafficMapBuilder
Returns
TrafficMapBuilder
Methods
build()
staticbuild<MapBuilder>(mapBuilder,options):MapBuilder
Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:246
Configures a map builder to generate a Garmin traffic map. The map consists of an optional active flight plan layer, an optional traffic range ring layer, a traffic intruder layer, an airplane icon layer, and an optional mini-compass layer. The map is centered on the player airplane and is locked to a Heading Up orientation.
The controller [GarminMapKeys.TrafficRange]: TrafficMapRangeController is added to the map context and can be
used to control the range of the traffic map.
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 | TrafficMapOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
buildNextGen()
staticbuildNextGen<MapBuilder>(mapBuilder,options):MapBuilder
Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:604
Configures a map builder to generate a next-generation (NXi, G3000, etc) Garmin traffic map. The map consists of an optional active flight plan layer, an optional traffic range ring layer, a traffic intruder layer, an airplane icon layer, and an optional mini-compass layer. The map is centered on the player airplane and is locked in Heading Up orientation.
The controller [GarminMapKeys.TrafficRange]: TrafficMapRangeController is added to the map context and can be
used to control the range of the traffic map.
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 | NextGenTrafficMapOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.