Class: G3000MapBuilder
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/G3000MapBuilder.ts:80
A G3000 map builder.
Constructors
Constructor
new G3000MapBuilder():
G3000MapBuilder
Returns
G3000MapBuilder
Methods
connextMap()
staticconnextMap<MapBuilder>(mapBuilder,options):MapBuilder
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/G3000MapBuilder.ts:363
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
| Parameter | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenConnextMapOptions, "userFacilityScopeFilter" | "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache" | "noGpsBannerText" | "supportWaypointHighlight"> & G3000MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
dataIntegrity()
staticdataIntegrity<MapBuilder>(mapBuilder,options):MapBuilder
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/G3000MapBuilder.ts:95
Configures a map builder to generate a map which supports updating its data integrity state from ADC, AHRS, and FMS position data.
Adds the following...
Modules:
[MapSystemKeys.DataIntegrity]: MapGarminDataIntegrityModule[MapSystemKeys.DataIntegrity]: MapDataIntegrityController
Type Parameters
| Type Parameter |
|---|
MapBuilder extends MapSystemBuilder<any, any, any, any> |
Parameters
| Parameter | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Readonly<G3000MapDataSourceOptions> | Options that define from where the map sources its data. |
Returns
MapBuilder
The map builder, after it has been configured.
getPfdIndexForDisplayPane()
staticgetPfdIndexForDisplayPane(displayPaneIndex,pfdCount):PfdIndex
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/G3000MapBuilder.ts:435
Gets the index of the PFD used by a map on a specific display pane.
Parameters
| Parameter | Type | Description |
|---|---|---|
displayPaneIndex | DisplayPaneIndex | The index of the display pane on which the map appears. |
pfdCount | 1 | 2 | The total number of available PFDs. |
Returns
The index of the PFD used by a map on the specified display pane.
hsiMap()
statichsiMap<MapBuilder>(mapBuilder,options):MapBuilder
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/G3000MapBuilder.ts:166
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
| Parameter | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenHsiMapOptions, "userFacilityScopeFilter" | "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache" | "supportWaypointHighlight"> & G3000MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
miniCompassIconSrc()
staticminiCompassIconSrc():string
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/G3000MapBuilder.ts:417
Gets the URI for the mini-compass icon's image asset.
Returns
string
The URI for the mini-compass icon's image asset.
navMap()
staticnavMap<MapBuilder>(mapBuilder,options):MapBuilder
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/G3000MapBuilder.ts:125
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
| Parameter | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenNavMapOptions, "userFacilityScopeFilter" | "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache" | "noGpsBannerText" | "supportWaypointHighlight"> & G3000MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
nearestMap()
staticnearestMap<MapBuilder>(mapBuilder,options):MapBuilder
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/G3000MapBuilder.ts:253
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
| Parameter | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenNearestMapOptions, "userFacilityScopeFilter" | "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache" | "noGpsBannerText"> & G3000MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
ownAirplaneIconOptions()
staticownAirplaneIconOptions(config,includeNoHeadingIcon):G3000MapOwnAirplaneIconOptions
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/G3000MapBuilder.ts:398
Gets a set of standard options for the map's own airplane icon.
Parameters
| Parameter | 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
G3000MapOwnAirplaneIconOptions
A set of standard options for the map's own airplane icon.
procMap()
staticprocMap<MapBuilder>(mapBuilder,options):MapBuilder
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/G3000MapBuilder.ts:299
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
| Parameter | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenProcMapOptions, "waypointIconImageCache" | "waypointStyleFontType" | "noGpsBannerText"> & G3000MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
relativeTerrainIconSrc()
staticrelativeTerrainIconSrc():string
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/G3000MapBuilder.ts:425
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()
statictrafficMap<MapBuilder>(mapBuilder,options):MapBuilder
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/G3000MapBuilder.ts:331
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
| Parameter | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenTrafficMapOptions, "waypointIconImageCache" | "waypointStyleFontType"> & G3000MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.
waypointMap()
staticwaypointMap<MapBuilder>(mapBuilder,options):MapBuilder
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/Map/G3000MapBuilder.ts:212
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
| Parameter | Type | Description |
|---|---|---|
mapBuilder | MapBuilder | The map builder to configure. |
options | Omit<NextGenWaypointMapOptions, "userFacilityScopeFilter" | "waypointIconImageCache" | "waypointStyleFontType" | "runwayDesignationImageCache" | "noGpsBannerText"> & G3000MapDataSourceOptions | Options for configuring the map. |
Returns
MapBuilder
The builder, after it has been configured.