Class: MapBuilder
A G3000 map builder.
Constructors
constructor
• new MapBuilder(): MapBuilder
Returns
Methods
connextMap
▸ connextMap<MapBuilder>(mapBuilder, options): MapBuilder
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
| Name | Type |
|---|---|
MapBuilder | extends MapSystemBuilder<any, any, any, any> |
Parameters
| Name | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenConnextMapOptions, "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache" | "noGpsBannerText"> & MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/Map/MapBuilder.ts:325
getIauIndexForDisplayPane
▸ getIauIndexForDisplayPane(displayPaneIndex): 1 | 2
Gets the index of the IAU (integrated avionics unit) used by a map on a specific display pane.
Parameters
| Name | Type | Description |
|---|---|---|
displayPaneIndex | DisplayPaneIndex | The 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.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/Map/MapBuilder.ts:389
hsiMap
▸ hsiMap<MapBuilder>(mapBuilder, options): MapBuilder
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
| Name | Type |
|---|---|
MapBuilder | extends MapSystemBuilder<any, any, any, any> |
Parameters
| Name | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenHsiMapOptions, "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache"> & MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/Map/MapBuilder.ts:130
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
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/Map/MapBuilder.ts:372
navMap
▸ navMap<MapBuilder>(mapBuilder, options): MapBuilder
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
| Name | Type |
|---|---|
MapBuilder | extends MapSystemBuilder<any, any, any, any> |
Parameters
| Name | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenNavMapOptions, "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache" | "noGpsBannerText"> & MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/Map/MapBuilder.ts:96
nearestMap
▸ nearestMap<MapBuilder>(mapBuilder, options): MapBuilder
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
| Name | Type |
|---|---|
MapBuilder | extends MapSystemBuilder<any, any, any, any> |
Parameters
| Name | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenNearestMapOptions, "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache" | "noGpsBannerText"> & MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/Map/MapBuilder.ts:210
ownAirplaneIconOptions
▸ ownAirplaneIconOptions(config, includeNoHeadingIcon?): MapOwnAirplaneIconOptions
Gets a set of standard options for the map's own airplane icon.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
config | MapConfig | undefined | The map configuration object defining the path to the own airplane icon's image asset. |
includeNoHeadingIcon | boolean | true | Whether to include the no-heading icon. Defaults to true. |
Returns
A set of standard options for the map's own airplane icon.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/Map/MapBuilder.ts:353
procMap
▸ procMap<MapBuilder>(mapBuilder, options): MapBuilder
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
| Name | Type |
|---|---|
MapBuilder | extends MapSystemBuilder<any, any, any, any> |
Parameters
| Name | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenProcMapOptions, "waypointIconImageCache" | "waypointStyleFontType" | "noGpsBannerText"> & MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/Map/MapBuilder.ts:255
relativeTerrainIconSrc
▸ relativeTerrainIconSrc(): string
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.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/Map/MapBuilder.ts:380
trafficMap
▸ trafficMap<MapBuilder>(mapBuilder, options): MapBuilder
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
| Name | Type |
|---|---|
MapBuilder | extends MapSystemBuilder<any, any, any, any> |
Parameters
| Name | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenTrafficMapOptions, "waypointIconImageCache" | "waypointStyleFontType"> & MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/Map/MapBuilder.ts:290
waypointMap
▸ waypointMap<MapBuilder>(mapBuilder, options): MapBuilder
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
| Name | Type |
|---|---|
MapBuilder | extends MapSystemBuilder<any, any, any, any> |
Parameters
| Name | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenWaypointMapOptions, "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache" | "noGpsBannerText"> & MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/Map/MapBuilder.ts:170