Type Alias: G3XWaypointMapOptions
G3XWaypointMapOptions =
object
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:40
Options for creating a G3X Touch waypoint map.
Properties
airplaneIconOrientation?
optional
airplaneIconOrientation:MapOwnAirplaneIconOrientation
|Subscribable
<MapOwnAirplaneIconOrientation
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:110
The orientation of the player airplane icon. Defaults to MapOwnAirplaneIconOrientation.HeadingUp
.
airplaneIconSrc
airplaneIconSrc:
string
|Subscribable
<string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:107
The URI of the player airplane icon's image asset
airportAutoRangeMargins?
optional
airportAutoRangeMargins:ReadonlyFloat64Array
|Subscribable
<ReadonlyFloat64Array
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:77
The nominal margins (relative to the map's dead zone boundaries), to respect when calculating the map range for
airports, as [left, top, right, bottom]
in pixels. Ignored if supportAirportAutoRange
is false
. Defaults to
[0, 0, 0, 0]
.
bingDelay?
optional
bingDelay:number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:48
The amount of time, in milliseconds, to delay binding the map's Bing Map instance. Defaults to 0.
bingId
bingId:
string
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:45
The ID to assign to the map's bound Bing Map instance.
dataUpdateFreq
dataUpdateFreq:
number
|Subscribable
<number
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:51
The frequency, in hertz, with which player airplane and autopilot properties are updated from event bus data.
defaultAirportRangeIndex?
optional
defaultAirportRangeIndex:number
|Subscribable
<number
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:70
The default map range index to apply when a range cannot be automatically selected for an airport. Ignored if
supportAirportAutoRange
is false
. If not defined, the map range will not be reset when targeting an airport
and a range cannot be automatically selected.
flightPlanner?
optional
flightPlanner:FlightPlanner
|Subscribable
<FlightPlanner
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:113
The flight planner containing the active flight plan. Required to display the active flight plan.
gduFormat
gduFormat:
GduFormat
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:42
The format of the map's parent GDU.
gduIndex
gduIndex:
number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:54
The index of the GDU from which the map sources data.
gduSettingManager
gduSettingManager:
UserSettingManager
<GduUserSettingTypes
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:57
A manager for GDU user settings.
includeAirspaces?
optional
includeAirspaces:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:104
Whether to display airspaces. Defaults to true
.
includeAltitudeArc?
optional
includeAltitudeArc:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:125
Whether to include the altitude intercept arc display. Defaults to true
.
includeDetailIndicator?
optional
includeDetailIndicator:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:131
Whether to include a detail indicator. Defaults to true
.
includeDragPan?
optional
includeDragPan:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:95
Whether to include support for drag-to-pan. Defaults to true
.
includeRunwayOutlines?
optional
includeRunwayOutlines:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:101
Whether to display airport runway outlines. Defaults to true
.
includeTrackVector?
optional
includeTrackVector:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:122
Whether to include the track vector display. Defaults to true
.
lnavIndex?
optional
lnavIndex:number
|Subscribable
<number
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:116
The index of the LNAV instance associated with the active flight plan. Required to display the active flight plan.
metricRangeArray?
optional
metricRangeArray: readonlyNumberUnitInterface
<UnitFamily.Distance
>[]
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:92
The map range array to use for metric units mode. Defaults to a standard range array.
nauticalRangeArray?
optional
nauticalRangeArray: readonlyNumberUnitInterface
<UnitFamily.Distance
>[]
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:89
The map range array to use for nautical units mode. Defaults to a standard range array.
nexradMinRangeIndex?
optional
nexradMinRangeIndex:number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:148
The minimum range index, inclusive, at which NEXRAD is visible.
noGpsBannerText?
optional
noGpsBannerText:string
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:98
The text of the banner that is displayed when GPS position is not available. Defaults to 'NO GPS POSITION'
.
projectedRange
projectedRange:
number
|Subscribable
<number
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:80
The projected scale of the map's nominal range, in pixels.
rangeTargetControlGroup?
optional
rangeTargetControlGroup:"top-right"
|"bottom-left"
|"bottom-right"
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:128
The indicator group in which to render the range/target control indicator. Defaults to 'top-right'
.
settingManager?
optional
settingManager:UserSettingManager
<Partial
<G3XMapUserSettingTypes
>>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:140
A user setting manager containing map settings. If not defined, map options will not be controlled by user settings.
showDetailIndicatorTitle?
optional
showDetailIndicatorTitle:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:134
Whether to show the detail indicator title. Defaults to true
. Ignored if includeDetailIndicator
is false
.
supportAirportAutoRange?
optional
supportAirportAutoRange:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:63
Whether the map should automatically adjust its range when the selected waypoint is an airport to give an
appropriate view of the selected runway, or all runways if there is no selected runway. Defaults to false
.
targetOffset?
optional
targetOffset:ReadonlyFloat64Array
|Subscribable
<ReadonlyFloat64Array
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:86
The nominal projected target offset of the map, as [x, y]
, where each component is expressed relative to the
width or height of the map's projected window, excluding the dead zone. Defaults to [0, 0]
.
unitsSettingManager?
optional
unitsSettingManager:UnitsUserSettingManager
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:143
A display units user setting manager. If not defined, map display units will not be controlled by user settings.
useAirspaceVisUserSettings?
optional
useAirspaceVisUserSettings:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:178
Whether to bind airspace visibility to user settings. Defaults to true
. Ignored if settingManager
is not
defined.
useAltitudeArcUserSettings?
optional
useAltitudeArcUserSettings:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:190
Whether to bind altitude intercept arc options to user settings. Defaults to true
. Ignored if settingManager
is not defined.
useCompassArcUserSettings?
optional
useCompassArcUserSettings:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:160
Whether to bind the display of the compass arc to user settings. Defaults to true
. Ignored if settingManager
is not defined.
useDeclutterUserSetting?
optional
useDeclutterUserSetting:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:166
Whether to bind the global declutter function to user settings. Defaults to true
. Ignored if settingManager
is
not defined.
useNexradUserSettings?
optional
useNexradUserSettings:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:154
Whether to bind the display of NEXRAD to user settings. Defaults to true
. Ignored if settingManager
is not
defined.
useTrackVectorUserSettings?
optional
useTrackVectorUserSettings:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:184
Whether to bind track vector options to user settings. Defaults to true
. Ignored if settingManager
is not
defined.
useWaypointUserSettings?
optional
useWaypointUserSettings:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:172
Whether to bind waypoint visibility and label text to user settings. Ignored if settingManager
is not
defined. Defaults to true
.
vnavIndex?
optional
vnavIndex:number
|Subscribable
<number
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XWaypointMapBuilder.tsx:119
The index of the VNAV instance associated with the active flight plan. Required to display the active flight plan.