Skip to main content

Type Alias: G3XNavMapOptions

G3XNavMapOptions = object

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:39

Options for creating a G3X Touch navigation map.

Properties​

airplaneIconOrientation?​

optional airplaneIconOrientation: MapOwnAirplaneIconOrientation | Subscribable<MapOwnAirplaneIconOrientation>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:103

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/G3XNavMapBuilder.tsx:100

The URI of the player airplane icon's image asset

allowRelativeTerrainMode?​

optional allowRelativeTerrainMode: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:217

Whether to allow relative terrain mode. Defaults to true. Ignored if useTerrainUserSettings is false or settingManager is not defined.

bingDelay?​

optional bingDelay: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:47

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/G3XNavMapBuilder.tsx:44

The ID to assign to the map's bound Bing Map instance.

compassArcOptions?​

optional compassArcOptions: Readonly<CompassArcOptions>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:91

Styling options for the compass arc. Required to display the compass arc.

dataUpdateFreq​

dataUpdateFreq: number | Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:50

The frequency, in hertz, with which player airplane and autopilot properties are updated from event bus data.

defaultFocusRangeIndex?​

optional defaultFocusRangeIndex: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:136

The default map range index to apply when the procedure focus consists of only a single point in space. Defaults to 7 (0.8 NM with standard range arrays).

drawEntirePlan?​

optional drawEntirePlan: boolean | Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:118

Whether to always draw the entire active flight plan, or a subscribable which provides it. Defaults to false. Ignored if the active flight plan is not displayed.

flightPlanner?​

optional flightPlanner: FlightPlanner | Subscribable<FlightPlanner>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:106

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/G3XNavMapBuilder.tsx:41

The format of the map's parent GDU.

gduIndex​

gduIndex: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:53

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/G3XNavMapBuilder.tsx:56

A manager for GDU user settings.

groundRelativeTerrainBlendDuration?​

optional groundRelativeTerrainBlendDuration: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:223

The amount of time, in milliseconds, over which to blend the on-ground and relative terrain mode colors when transitioning between the two. Defaults to 10000 milliseconds.

includeAirspaces?​

optional includeAirspaces: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:97

Whether to display airspaces. Defaults to true.

includeAltitudeArc?​

optional includeAltitudeArc: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:148

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/G3XNavMapBuilder.tsx:163

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/G3XNavMapBuilder.tsx:85

Whether to include support for drag-to-pan. Defaults to true.

includeMiniCompass?​

optional includeMiniCompass: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:151

Whether to include a mini-compass. Defaults to true.

includeOrientationToggle?​

optional includeOrientationToggle: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:157

Whether the mini-compass should function as a toggle button for map orientation. Ignored if includeMiniCompass is false. Defaults to false.

includeRelativeTerrainStatusIndicator?​

optional includeRelativeTerrainStatusIndicator: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:178

Whether to include a relative terrain mode status indicator. Defaults to true.

includeRunwayOutlines?​

optional includeRunwayOutlines: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:94

Whether to display airport runway outlines. Defaults to true.

includeTerrainScale?​

optional includeTerrainScale: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:175

Whether to include a terrain scale indicator. Defaults to true.

includeTrackVector?​

optional includeTrackVector: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:145

Whether to include the track vector display. Defaults to true.

includeTrafficFailedIndicator?​

optional includeTrafficFailedIndicator: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:172

Whether to include a traffic failed mode indicator. Defaults to true.

includeTrafficOffScaleIndicator?​

optional includeTrafficOffScaleIndicator: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:169

Whether to include a traffic off-scale status indicator. Defaults to true.

includeTrafficStatusIndicator?​

optional includeTrafficStatusIndicator: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:181

Whether to include a traffic status indicator. Defaults to true.

optional lnavIndex: number | Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:109

The index of the LNAV instance associated with the active flight plan. Required to display the active flight plan.

metricRangeArray?​

optional metricRangeArray: readonly NumberUnitInterface<UnitFamily.Distance>[]

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:82

The map range array to use for metric units mode. Defaults to a standard range array.

nauticalRangeArray?​

optional nauticalRangeArray: readonly NumberUnitInterface<UnitFamily.Distance>[]

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:79

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/G3XNavMapBuilder.tsx:228

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/G3XNavMapBuilder.tsx:88

The text of the banner that is displayed when GPS position is not available. Defaults to 'NO GPS POSITION'.

nominalFocusMargins?​

optional nominalFocusMargins: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:130

A subscribable which provides the nominal focus margins, as [left, top, right, bottom] in pixels. The nominal margins define the offset of the boundaries of the focus region relative to the map's projected window, excluding the dead zone. Positive values represent offsets toward the center of the window. When the flight plan is focused, the focused elements of the plan are guaranteed to be contained within the focus region. Defaults to [0, 0, 0, 0].

projectedRange​

projectedRange: number | Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:62

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/G3XNavMapBuilder.tsx:160

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/G3XNavMapBuilder.tsx:193

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/G3XNavMapBuilder.tsx:166

Whether to show the detail indicator title. Defaults to true. Ignored if includeDetailIndicator is false.

showTrafficAltRestriction?​

optional showTrafficAltRestriction: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:187

Whether to show the traffic altitude restriction mode on the traffic status indicator. Defaults to true. Ignored if includeTrafficStatusIndicator is false.

supportFlightPlanFocus?​

optional supportFlightPlanFocus: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:121

Whether to support flight plan focus. Defaults to false. Ignored if the active flight plan is not displayed.

targetOffsets?​

optional targetOffsets: Partial<Record<MapOrientation, ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>>>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:76

The nominal projected target offset of the map for each orientation mode, 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 the following:

{
  [MapOrientation.NorthUp]: [0, 0],
  [MapOrientation.TrackUp]: [0, 0.25],
  [MapOrientation.DtkUp]: [0, 0.25]
}

trafficIconOptions?​

optional trafficIconOptions: G3XNavMapTrafficIconOptions

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:142

Configuration options for traffic icons. Required to display traffic.

trafficSettingManager?​

optional trafficSettingManager: UserSettingManager<Partial<TrafficUserSettingTypes>>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:199

A user setting manager containing settings controlling the operation of the traffic system. If not defined, certain traffic display options will not be controlled by user settings.

trafficSystem?​

optional trafficSystem: TrafficSystem

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:139

The traffic system from which to retrieve traffic intruder data. Required to display traffic.

unitsSettingManager?​

optional unitsSettingManager: UnitsUserSettingManager

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:202

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/G3XNavMapBuilder.tsx:258

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/G3XNavMapBuilder.tsx:270

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/G3XNavMapBuilder.tsx:240

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/G3XNavMapBuilder.tsx:246

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/G3XNavMapBuilder.tsx:234

Whether to bind the display of NEXRAD to user settings. Defaults to true. Ignored if settingManager is not defined.

useOrientationUserSettings?​

optional useOrientationUserSettings: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:208

Whether to bind map orientation to user settings. Defaults to true. Ignored if settingManager is not defined.

useRangeUserSettingByDefault?​

optional useRangeUserSettingByDefault: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:205

Whether the map's range should be controlled by user setting by default. Defaults to true.

useTerrainUserSettings?​

optional useTerrainUserSettings: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:211

Whether to bind terrain colors 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/G3XNavMapBuilder.tsx:264

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/G3XNavMapBuilder.tsx:252

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/G3XNavMapBuilder.tsx:112

The index of the VNAV instance associated with the active flight plan. Required to display the active flight plan.

waypointStyleScale?​

optional waypointStyleScale: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Map/Assembled/G3XNavMapBuilder.tsx:59

The scaling factor of waypoint icons and labels. Defaults to 1.