Skip to main content

Class: MapBuilder

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/MapBuilder.ts:77

A G3000 map builder.

Constructors

Constructor

new MapBuilder(): MapBuilder

Returns

MapBuilder

Methods

connextMap()

static connextMap<MapBuilder>(mapBuilder, options): MapBuilder

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/MapBuilder.ts:325

Configures a map builder to generate a G3000 Connext weather map.

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

ParameterTypeDescription
mapBuilderMapBuilderThe map builder to configure.
optionsOmit<NextGenConnextMapOptions, "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache" | "noGpsBannerText"> & MapDataSourceOptionsOptions for configuring the map.

Returns

MapBuilder

The builder, after it has been configured.


getIauIndexForDisplayPane()

static getIauIndexForDisplayPane(displayPaneIndex): 1 | 2

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/MapBuilder.ts:389

Gets the index of the IAU (integrated avionics unit) used by a map on a specific display pane.

Parameters

ParameterTypeDescription
displayPaneIndexDisplayPaneIndexThe index of the display pane on which the map appears.

Returns

1 | 2

The index of the IAU (integrated avionics unit) used by a map on the specified display pane.


hsiMap()

static hsiMap<MapBuilder>(mapBuilder, options): MapBuilder

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/MapBuilder.ts:130

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

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

Parameters

ParameterTypeDescription
mapBuilderMapBuilderThe map builder to configure.
optionsOmit<NextGenHsiMapOptions, "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache"> & MapDataSourceOptionsOptions for configuring the map.

Returns

MapBuilder

The builder, after it has been configured.


miniCompassIconSrc()

static miniCompassIconSrc(): string

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/MapBuilder.ts:372

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

Returns

string

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


static navMap<MapBuilder>(mapBuilder, options): MapBuilder

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/MapBuilder.ts:96

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

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

Parameters

ParameterTypeDescription
mapBuilderMapBuilderThe map builder to configure.
optionsOmit<NextGenNavMapOptions, "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache" | "noGpsBannerText"> & MapDataSourceOptionsOptions for configuring the map.

Returns

MapBuilder

The builder, after it has been configured.


nearestMap()

static nearestMap<MapBuilder>(mapBuilder, options): MapBuilder

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/MapBuilder.ts:210

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

ParameterTypeDescription
mapBuilderMapBuilderThe map builder to configure.
optionsOmit<NextGenNearestMapOptions, "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache" | "noGpsBannerText"> & MapDataSourceOptionsOptions for configuring the map.

Returns

MapBuilder

The builder, after it has been configured.


ownAirplaneIconOptions()

static ownAirplaneIconOptions(config, includeNoHeadingIcon): MapOwnAirplaneIconOptions

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/MapBuilder.ts:353

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

Parameters

ParameterTypeDefault valueDescription
configMapConfigundefinedThe map configuration object defining the path to the own airplane icon's image asset.
includeNoHeadingIconbooleantrueWhether to include the no-heading icon. Defaults to true.

Returns

MapOwnAirplaneIconOptions

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


procMap()

static procMap<MapBuilder>(mapBuilder, options): MapBuilder

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/MapBuilder.ts:255

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

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

Parameters

ParameterTypeDescription
mapBuilderMapBuilderThe map builder to configure.
optionsOmit<NextGenProcMapOptions, "waypointIconImageCache" | "waypointStyleFontType" | "noGpsBannerText"> & MapDataSourceOptionsOptions for configuring the map.

Returns

MapBuilder

The builder, after it has been configured.


relativeTerrainIconSrc()

static relativeTerrainIconSrc(): string

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/MapBuilder.ts:380

Gets the URI for the relative terrain mode indicator icon's image asset.

Returns

string

The URI for the relative terrain mode indicator icon's image asset.


trafficMap()

static trafficMap<MapBuilder>(mapBuilder, options): MapBuilder

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/MapBuilder.ts:290

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

ParameterTypeDescription
mapBuilderMapBuilderThe map builder to configure.
optionsOmit<NextGenTrafficMapOptions, "waypointIconImageCache" | "waypointStyleFontType"> & MapDataSourceOptionsOptions for configuring the map.

Returns

MapBuilder

The builder, after it has been configured.


waypointMap()

static waypointMap<MapBuilder>(mapBuilder, options): MapBuilder

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/MapBuilder.ts:170

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

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

Parameters

ParameterTypeDescription
mapBuilderMapBuilderThe map builder to configure.
optionsOmit<NextGenWaypointMapOptions, "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache" | "noGpsBannerText"> & MapDataSourceOptionsOptions for configuring the map.

Returns

MapBuilder

The builder, after it has been configured.