Skip to main content

Type Alias: G3XWaypointMapOptions

G3XWaypointMapOptions = object

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

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:120

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:117

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:87

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:53

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:50

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

dataUpdateFreq​

dataUpdateFreq: number | null | Subscribable<number | null>

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

The default frequency, in hertz, at which to update player airplane and autopilot properties from their bound data sources. If the frequency is null, then updates will not be throttled by frequency - each property will be updated as soon as the value of its data source changes. If the frequency is not null, then each property will only be updated when the map is updated, and the frequency of updates will not exceed updateFreq.

defaultAirportRangeIndex?​

optional defaultAirportRangeIndex: number | Subscribable<number>

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

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.

facilityLoader?​

optional facilityLoader: FacilityLoader

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

The facility loader to use. If not defined, then a default instance will be created.

flightPlanner?​

optional flightPlanner: FlightPlanner | Subscribable<FlightPlanner>

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

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:44

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:64

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:67

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:114

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:135

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:141

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:105

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:111

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:132

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

optional lnavIndex: number | Subscribable<number>

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

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

metricRangeArray?​

optional metricRangeArray: readonly NumberUnitInterface<Distance>[]

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

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

nauticalRangeArray?​

optional nauticalRangeArray: readonly NumberUnitInterface<Distance>[]

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

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:158

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:108

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:90

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:138

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:150

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:144

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:73

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:96

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:153

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:188

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:200

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:170

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:176

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:164

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:194

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:182

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:129

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