Skip to main content

Class: MapBuilder

Constructors

constructor

new MapBuilder(): MapBuilder

Returns

MapBuilder

Methods

hsiMap

hsiMap<MapBuilder>(mapBuilder, options): MapBuilder

Configures a map builder to generate a G1000 NXi HSI map.

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

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.
optionsNextGenHsiMapOptionsOptions for configuring the map.

Returns

MapBuilder

The builder, after it has been configured.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/Map/MapBuilder.ts:102


miniCompassIconSrc

miniCompassIconSrc(): string

Gets the URI for the mini-compass icon's image asset.

Returns

string

The URI for the mini-compass icon's image asset.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/Map/MapBuilder.ts:282


navMap<MapBuilder>(mapBuilder, options): MapBuilder

Configures a map builder to generate a G1000 NXi navigation map.

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

If flight plan focus is supported, the module [GarminMapKeys.FlightPlanFocus]: MapFlightPlanFocusModule is added to the map model and can be used to control the focus.

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.
optionsNextGenNavMapOptionsOptions for configuring the map.

Returns

MapBuilder

The builder, after it has been configured.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/Map/MapBuilder.ts:74


nearestMap

nearestMap<MapBuilder>(mapBuilder, options): MapBuilder

Configures a map builder to generate a G1000 NXi 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

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/Map/MapBuilder.ts:172


ownAirplaneIconOptions

ownAirplaneIconOptions(includeNoHeadingIcon?): MapOwnAirplaneIconOptions

Gets a set of standard options for the map's own airplane icon.

Parameters

NameTypeDefault valueDescription
includeNoHeadingIconbooleantrueWhether to include the no-heading icon. Defaults to true.

Returns

MapOwnAirplaneIconOptions

A set of standard options for the map's own airplane icon.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/Map/MapBuilder.ts:263


procMap

procMap<MapBuilder>(mapBuilder, options): MapBuilder

Configures a map builder to generate a G1000 NXi procedure map. The map displays a flight plan procedure (departure, arrival, approach) and its transitions, and is always focused on the displayed procedure. The map is also locked to a North Up orientation.

The module [GarminMapKeys.ProcedurePreview]: MapProcedurePreviewModule is added to the map model and can be used to control the displayed procedure.

The module [GarminMapKeys.FlightPlanFocus]: MapFlightPlanFocusModule is added to the map model and can be used to control the procedure focus.

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.
optionsNextGenProcMapOptionsOptions for configuring the map.

Returns

MapBuilder

The builder, after it has been configured.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/Map/MapBuilder.ts:211


trafficMap

trafficMap<MapBuilder>(mapBuilder, options): MapBuilder

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

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

Parameters

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

Returns

MapBuilder

The builder, after it has been configured.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/Map/MapBuilder.ts:242


waypointMap

waypointMap<MapBuilder>(mapBuilder, options): MapBuilder

Configures a map builder to generate a G1000 NXi waypoint map. The map is locked to a North Up orientation, targets a highlighted waypoint, and follows the player airplane when there is no highlighted waypoint.

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 waypoint 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.
optionsNextGenWaypointMapOptionsOptions for configuring the map.

Returns

MapBuilder

The builder, after it has been configured.

Defined in

workingtitle-instruments-g1000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG1000/Shared/Map/MapBuilder.ts:138