Skip to main content

Type Alias: G3XNearestMapOptions

G3XNearestMapOptions = object

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

Options for creating a G3X Touch nearest map.

Properties​

airplaneIconOrientation?​

optional airplaneIconOrientation: MapOwnAirplaneIconOrientation | Subscribable<MapOwnAirplaneIconOrientation>

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

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/G3XNearestMapBuilder.tsx:103

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/G3XNearestMapBuilder.tsx:184

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/G3XNearestMapBuilder.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/G3XNearestMapBuilder.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/G3XNearestMapBuilder.tsx:51

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

flightPlanner?​

optional flightPlanner: FlightPlanner | Subscribable<FlightPlanner>

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

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/G3XNearestMapBuilder.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/G3XNearestMapBuilder.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/G3XNearestMapBuilder.tsx:57

A manager for GDU user settings.

groundRelativeTerrainBlendDuration?​

optional groundRelativeTerrainBlendDuration: number

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

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.

highlightLineOptions?​

optional highlightLineOptions: Readonly<WaypointHighlightLineOptions>

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

Styling options for the waypoint highlight line. Defaults to the options returned by G3XMapUtils.waypointHighlightLineOptions() for the appropriate GDU format.

highlightMargins?​

optional highlightMargins: ReadonlyFloat64Array

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

The margins around the projected map boundaries to respect when automatically selecting a range to place a highlighted waypoint in view, as [left, top, right, bottom] in pixels. Positive values move the margin inwards toward the center of the projection. Defaults to [0, 0, 0, 0].

includeAirspaces?​

optional includeAirspaces: boolean

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

Whether to display airspaces. Defaults to true.

includeAltitudeArc?​

optional includeAltitudeArc: boolean

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

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/G3XNearestMapBuilder.tsx:136

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/G3XNearestMapBuilder.tsx:91

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/G3XNearestMapBuilder.tsx:130

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

includeRelativeTerrainStatusIndicator?​

optional includeRelativeTerrainStatusIndicator: boolean

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

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/G3XNearestMapBuilder.tsx:97

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/G3XNearestMapBuilder.tsx:148

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/G3XNearestMapBuilder.tsx:124

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/G3XNearestMapBuilder.tsx:145

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/G3XNearestMapBuilder.tsx:142

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/G3XNearestMapBuilder.tsx:154

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

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

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

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/G3XNearestMapBuilder.tsx:195

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/G3XNearestMapBuilder.tsx:94

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/G3XNearestMapBuilder.tsx:76

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/G3XNearestMapBuilder.tsx:133

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

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/G3XNearestMapBuilder.tsx:139

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

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

targetOffset?​

optional targetOffset: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

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

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].

trafficIconOptions?​

optional trafficIconOptions: G3XNearestMapTrafficIconOptions

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

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/G3XNearestMapBuilder.tsx:172

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/G3XNearestMapBuilder.tsx:118

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/G3XNearestMapBuilder.tsx:175

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/G3XNearestMapBuilder.tsx:219

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/G3XNearestMapBuilder.tsx:231

Whether to bind altitude intercept arc options 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/G3XNearestMapBuilder.tsx:207

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/G3XNearestMapBuilder.tsx:201

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

useTerrainUserSettings?​

optional useTerrainUserSettings: boolean

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

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/G3XNearestMapBuilder.tsx:225

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/G3XNearestMapBuilder.tsx:213

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/G3XNearestMapBuilder.tsx:115

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/G3XNearestMapBuilder.tsx:73

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