Skip to main content

Type Alias: G3XProcPreviewMapOptions

G3XProcPreviewMapOptions = object

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

Options for creating a G3X Touch procedure preview map.

Properties

airplaneIconOrientation?

optional airplaneIconOrientation: MapOwnAirplaneIconOrientation | Subscribable<MapOwnAirplaneIconOrientation>

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

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

The URI of the player airplane icon's image asset


bingDelay?

optional bingDelay: number

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

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/G3XProcPreviewMapBuilder.tsx:34

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/G3XProcPreviewMapBuilder.tsx:40

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

The default map range index to apply when the procedure focus consists of only a single point in space. Defaults to 17 (25 NM/50 KM with standard range arrays).


gduFormat

gduFormat: GduFormat

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

The format of the map's parent GDU.


gduIndex

gduIndex: number

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

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/G3XProcPreviewMapBuilder.tsx:46

A manager for GDU user settings.


includeAirspaces?

optional includeAirspaces: boolean

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

Whether to display airspaces. Defaults to true.


includeAltitudeArc?

optional includeAltitudeArc: boolean

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

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

Whether to include a detail indicator. Defaults to true.


includeRunwayOutlines?

optional includeRunwayOutlines: boolean

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

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

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


metricRangeArray?

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

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

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/G3XProcPreviewMapBuilder.tsx:58

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


noGpsBannerText?

optional noGpsBannerText: string

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

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

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/G3XProcPreviewMapBuilder.tsx:49

The projected scale of the map's nominal range, in pixels.


settingManager?

optional settingManager: UserSettingManager<Partial<G3XMapUserSettingTypes>>

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

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

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


targetOffset?

optional targetOffset: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

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

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

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

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

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

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

Whether to bind the global declutter function 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/G3XProcPreviewMapBuilder.tsx:142

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

Whether to bind waypoint visibility and label text to user settings. Ignored if settingManager is not defined. Defaults to true.