Skip to main content

@microsoft/msfs-wt21-shared

Enumerations​

Classes​

Interfaces​

Type Aliases​

AOAFormat​

Ƭ AOAFormat: typeof aoaFormatOptions[number]

A format for the AOA component.

Defined in​

workingtitle-instruments-wt21/shared/Profiles/PFDUserSettings.ts:4

ApproachDetails​

Ƭ ApproachDetails: Object

FMS Approach Details

Type declaration​

NameTypeDescription
approachIsActivebooleanWhether the approach is active
approachIsCirclingbooleanWhether the approach is circling
approachLoadedbooleanWhether an approach is loaded.
approachRnavTypeRnavTypeFlagsThe Approach RNAV Type
approachTypeExtendedApproachTypeThe Approach Type
referenceFacilityVorFacility | nullThe reference navaid for the approach

Defined in​

workingtitle-instruments-wt21/shared/Systems/FMS/WT21FmsTypes.ts:14

ApproachNameParts​

Ƭ ApproachNameParts: Object

A type representing the three parts of an approach name.

Type declaration​

NameTypeDescription
flags?stringAdditonal flags (eg, RNAV type)
runway?stringThe runway identifier.
suffix?stringThe approach suffix
transition?stringThe approach transition name.
typestringThe approach type.

Defined in​

workingtitle-instruments-wt21/shared/Systems/FMS/WT21FmsUtils.ts:1349

DefaultsSettings​

Ƭ DefaultsSettings: { readonly [Item in typeof defaultsSettings[number] as Item["name"]]: Item["defaultValue"] }

Generates the UserSettingDefinition type based on the settings object

Defined in​

workingtitle-instruments-wt21/shared/Profiles/DefaultsUserSettings.ts:88

ElapsedTimeState​

Ƭ ElapsedTimeState: "Off" | "Started" | "Stopped"

Defined in​

workingtitle-instruments-wt21/shared/DCP/ElapsedTime.ts:7

FgpSettings​

Ƭ FgpSettings: { readonly [Item in typeof fgpSettings[number] as Item["name"]]: Item["defaultValue"] }

Generates the UserSettingDefinition type based on the settings object

Defined in​

workingtitle-instruments-wt21/shared/Profiles/FgpUserSettings.ts:34

FmcSettingsManagerType​

Ƭ FmcSettingsManagerType: Object

Type description for pfd user settings

Type declaration​

NameTypeDescription
baroHpabooleanThe baro unit setting.
flightNumberstringThe flight number setting.
simbriefPilotIdnumberThe setting for simbrief pilot id.

Defined in​

workingtitle-instruments-wt21/shared/Profiles/FmcUserSettings.ts:6

GpwsData​

Ƭ GpwsData: Object

Data provided by GPWS to modules.

Type declaration​

NameTypeDescription
geoAltitudenumberThe current geometric altitude of the airplane, in feet.
geoVerticalSpeednumberThe current geometric vertical speed of the airplane, in feet per minute.
gpsPosGeoPointReadOnlyThe current GPS position of the airplane.
isGsGpActivebooleanWhether the autopilot GS or GP mode is active.
isOnGroundbooleanWhether the airplane is on the ground.
isPosValidbooleanWhether GPWS has a valid position fix.
isRadarAltitudeValidbooleanWhether GPWS has a valid radar altitude.
nearestRunwayAltitudenumber | nullThe altitude of the nearest runway, in feet, or null if nearest runway data are not available.
radarAltitudenumberThe current radar altitude of the airplane, in feet.

Defined in​

workingtitle-instruments-wt21/shared/Systems/gpws/GpwsModule.ts:8

GuiUiControlEvents​

Ƭ GuiUiControlEvents: Record<GuiHEvent, UiControlEventHandler<WT21UiControl>>

HardwareUiControl events for GUI interaction H events.

Defined in​

workingtitle-instruments-wt21/shared/UI/WT21UiControl.tsx:10

HSIFormat​

Ƭ HSIFormat: typeof hsiFormatsAll[number]

A format for the HSI compass.

Defined in​

workingtitle-instruments-wt21/shared/Map/MapUserSettings.ts:6

HSITickDirection​

Ƭ HSITickDirection: "Inwards" | "Outwards"

Direction that ticks should point on a compass rose.

Defined in​

workingtitle-instruments-wt21/shared/LowerSection/HSI/HSICommon.tsx:23

MFDSettings​

Ƭ MFDSettings: { readonly [Item in typeof mfdSettings[number] as Item["name"]]: Item["defaultValue"] }

Generates the UserSettingDefinition type based on the settings object

Defined in​

workingtitle-instruments-wt21/shared/Profiles/MFDUserSettings.tsx:169

MFDSettingsAliased​

Ƭ MFDSettingsAliased: { readonly [Item in typeof mfdSettingsAliased[number] as Item["name"]]: Item["defaultValue"] }

Generates the UserSettingDefinition type based on the settings object

Defined in​

workingtitle-instruments-wt21/shared/Profiles/MFDUserSettings.tsx:174

MapFixInfoWaypointIconOptions​

Ƭ MapFixInfoWaypointIconOptions: Object

Initialization options for a MapFixInfoWaypointIcon.

Type declaration​

NameTypeDescription
outlineColorstringThe color of the outline for the ring.
outlineWidthnumberThe width of the outline for the ring, in pixels.
strokeColorstringThe color of the stroke for the ring.
strokeWidthnumberThe width of the stroke for the ring, in pixels.

Defined in​

workingtitle-instruments-wt21/shared/Map/MapTod.ts:89

MapRange​

Ƭ MapRange: typeof mapRanges[number]

A format for the HSI compass.

Defined in​

workingtitle-instruments-wt21/shared/Map/MapUserSettings.ts:12

MapSettings​

Ƭ MapSettings: { readonly [Item in typeof mapSettings[number] as Item["name"]]: Item["defaultValue"] }

Type definitions for all map settings.

Defined in​

workingtitle-instruments-wt21/shared/Map/MapUserSettings.ts:183

MapSettingsMfdAliased​

Ƭ MapSettingsMfdAliased: { readonly [Item in typeof mapSettingsMfdAliased[number] as Item["name"]]: Item["defaultValue"] }

Type definitions for aliased PFD/MFD map settings.

Defined in​

workingtitle-instruments-wt21/shared/Map/MapUserSettings.ts:193

MapSettingsPfdAliased​

Ƭ MapSettingsPfdAliased: { readonly [Item in typeof mapSettingsPfdAliased[number] as Item["name"]]: Item["defaultValue"] }

Type definitions for aliased PFD/MFD map settings.

Defined in​

workingtitle-instruments-wt21/shared/Map/MapUserSettings.ts:188

Ƭ NavBaseControlEvents<Prefix, T>: { readonly [Item in Extract<keyof T, string> as `${Prefix}_set_${Item}`]: T[Item] }

Generates control event types for each field.

Type parameters​

NameType
Prefixextends string
Textends Object

Defined in​

workingtitle-instruments-wt21/shared/Navigation/NavBase.ts:102

Ƭ NavBaseEvents<Prefix, T>: { readonly [Item in Extract<keyof T, string> as `${Prefix}_${Item}`]: ExtractSubjectType<T[Item]> }

Generates event types for each field.

Type parameters​

NameType
Prefixextends string
Textends NavBaseFields

Defined in​

workingtitle-instruments-wt21/shared/Navigation/NavBase.ts:97

Ƭ NavIndicatorControlEvents<NavSourceNames, IndicatorNames, Indicator, Fields>: NavBaseControlEvents<`nav_ind_${Indicator}`, Fields & NavIndicatorControlFields<NavSourceNames>>

Control events for changing field values of a NavIndicator.

Type parameters​

NameType
NavSourceNamesextends readonly string[]
IndicatorNamesextends readonly string[]
Indicatorextends IndicatorNames[number]
Fieldsextends Object = {}

Defined in​

workingtitle-instruments-wt21/shared/Navigation/NavIndicators/NavIndicators.ts:21

Ƭ NavIndicatorEvents<T, Indicator>: NavBaseEvents<`nav_ind_${Indicator}`, NavIndicatorFields<T>>

Field changed events for NavIndicator fields.

Type parameters​

NameType
Textends readonly string[]
Indicatorextends string[number]

Defined in​

workingtitle-instruments-wt21/shared/Navigation/NavIndicators/NavIndicators.ts:17

PFDSettings​

Ƭ PFDSettings: { readonly [Item in typeof pfdSettings[number] as Item["name"]]: Item["defaultValue"] }

Generates the UserSettingDefinition type based on the settings object

Defined in​

workingtitle-instruments-wt21/shared/Profiles/PFDUserSettings.ts:30

PfdOrMfd​

Ƭ PfdOrMfd: "PFD" | "MFD"

Defined in​

workingtitle-instruments-wt21/shared/Map/MapUserSettings.ts:15

RefsSettings​

Ƭ RefsSettings: { readonly [Item in typeof refsSettings[number] as Item["name"]]: Item["defaultValue"] }

Generates the UserSettingDefinition type based on the settings object

Defined in​

workingtitle-instruments-wt21/shared/Profiles/RefsUserSettings.ts:19

TerrWxState​

Ƭ TerrWxState: typeof terrWxStates[number]

TERR/WX state

Defined in​

workingtitle-instruments-wt21/shared/Map/MapUserSettings.ts:9

TrafficSettings​

Ƭ TrafficSettings: { readonly [Item in typeof trafficSettings[number] as Item["name"]]: Item["defaultValue"] }

Type definitions for traffic settings.

Defined in​

workingtitle-instruments-wt21/shared/Traffic/TrafficUserSettings.ts:36

VSpeedData​

Ƭ VSpeedData: Object

Type declaration​

NameTypeDescription
manualbooleanIndicates if this vspeed was modified by the pilot.
showbooleanIndicates if this vspeed should be shown.
valuenumberThe set value of this vspeed

Defined in​

workingtitle-instruments-wt21/shared/Profiles/VSpeedUserSettings.ts:6

VSpeedDataAliased​

Ƭ VSpeedDataAliased: Object

Index signature​

▪ [type: `vspeed_type_${string}`]: VSpeedType

The type of this vspeed.

Defined in​

workingtitle-instruments-wt21/shared/Profiles/VSpeedUserSettings.ts:16

WT21BearingPointerControlEvents​

Ƭ WT21BearingPointerControlEvents: WT21BearingPointer1ControlEvents & WT21BearingPointer2ControlEvents

Events for controlling the WT21 bearing pointers. Sync should always be true for these events.

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:229

WT21CourseNeedleNavSource​

Ƭ WT21CourseNeedleNavSource: NavSourceBase<WT21CourseNeedleNavSourceNames>

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:50

WT21CourseNeedleNavSourceName​

Ƭ WT21CourseNeedleNavSourceName: WT21CourseNeedleNavSourceNames[number]

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:42

WT21CourseNeedleNavSourceNames​

Ƭ WT21CourseNeedleNavSourceNames: typeof courseNeedleNavSourceNames

The names of the available nav sources in the WT21 for the course needle.

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:40

WT21CourseNeedleNavSources​

Ƭ WT21CourseNeedleNavSources: NavSources<WT21CourseNeedleNavSourceNames>

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:48

WT21DisplayUnitIndex​

Ƭ WT21DisplayUnitIndex: 1 | 2

WT21 display unit type. Not taken into account for WT21DisplayUnitType.Pfd

Defined in​

workingtitle-instruments-wt21/shared/WT21DisplayUnitFsInstrument.ts:18

WT21GhostNeedleControlEvents​

Ƭ WT21GhostNeedleControlEvents: WT21NavIndicatorControlEvents<"ghostNeedle", ExtractSubjectTypes<Pick<WT21GhostNeedleNavIndicator, "isArmed" | "isVisible">>>

Events for controlling the ghost needle.

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:192

WT21LNavDataEvents​

Ƭ WT21LNavDataEvents: WT21LNavDataSimVarEvents

Events related to WT21 LNAV data.

Defined in​

workingtitle-instruments-wt21/shared/Systems/Autopilot/WT21LNavDataEvents.ts:61

WT21NavIndicator​

Ƭ WT21NavIndicator: NavIndicator<WT21NavSourceNames>

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:57

WT21NavIndicatorEvents​

Ƭ WT21NavIndicatorEvents<Indicator>: NavIndicatorEvents<WT21NavSourceNames, Indicator>

Field changed events for WT21 Nav Indicator fields.

Type parameters​

NameType
Indicatorextends WT21NavIndicatorNames[number]

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:66

WT21NavIndicatorName​

Ƭ WT21NavIndicatorName: WT21NavIndicatorNames[number]

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:55

WT21NavIndicatorNames​

Ƭ WT21NavIndicatorNames: typeof navIndicatorNames

The names of the nav indicators in the WT21.

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:53

WT21NavIndicators​

Ƭ WT21NavIndicators: NavIndicators<WT21NavSourceNames, WT21NavIndicatorNames>

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:59

WT21NavSource​

Ƭ WT21NavSource: NavSourceBase<WT21NavSourceNames>

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:44

WT21NavSourceEvents​

Ƭ WT21NavSourceEvents<Source, Index>: NavBaseEvents<`nav_src_${Source}_${Index}`, NavBaseFields>

Field changed events for WT21 Nav Source fields.

Type parameters​

NameType
Sourceextends WT21NavSourceNames[number]
Indexextends number

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:62

WT21NavSourceName​

Ƭ WT21NavSourceName: WT21NavSourceNames[number]

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:38

WT21NavSourceNames​

Ƭ WT21NavSourceNames: typeof navSourceNames

The names of the available nav sources in the WT21.

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:36

WT21NavSources​

Ƭ WT21NavSources: NavSources<WT21NavSourceNames>

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavIndicators.ts:46

WT21NavigationSettings​

Ƭ WT21NavigationSettings: { readonly [Item in typeof navigationSettings[number] as Item["name"]]: Item["defaultValue"] }

Generates the UserSettingDefinition type based on the settings object

Defined in​

workingtitle-instruments-wt21/shared/Navigation/WT21NavigationUserSettings.ts:25

WT21Settings​

Ƭ WT21Settings: { readonly [Item in typeof userSettings[number] as Item["name"]]: Item["defaultValue"] }

Generates the UserSettingDefinition type based on the settings object

Defined in​

workingtitle-instruments-wt21/shared/Profiles/WT21UserSettings.ts:21

Variables​

HSICommon​

• Const HSICommon: Readonly<{ hsiPposAircraftSymbolSVGPath: () => any ; hsiStickAircraftSymbolSVGPath: () => any }>

Defined in​

workingtitle-instruments-wt21/shared/LowerSection/HSI/HSICommon.tsx:3

• NavIndicatorContext: Context<WT21NavIndicators>

Defined in​

workingtitle-instruments-wt21/shared/Navigation/NavIndicators/NavIndicatorContext.ts:5

WT21FixInfoConfig​

• Const WT21FixInfoConfig: WT21FixInfoOptions

Defined in​

workingtitle-instruments-wt21/shared/Systems/FixInfo/WT21FixInfoConfig.ts:5

WT21FlightPlanPredictorConfiguration​

• Const WT21FlightPlanPredictorConfiguration: FlightPlanPredictorConfiguration

WT21 Configuration for flight plan predictor

Defined in​

workingtitle-instruments-wt21/shared/WT21FlightPlanPredictorConfiguration.ts:6

WT21_H_EVENT_GENERIC_UPR_REGEX​

• Const WT21_H_EVENT_GENERIC_UPR_REGEX: RegExp

Defined in​

workingtitle-instruments-wt21/shared/DCP/DcpHEvents.ts:3

Functions​

initNavIndicatorContext​

▸ initNavIndicatorContext(navIndicatorsInstrument): void

TODO

Parameters​

NameTypeDescription
navIndicatorsInstrumentWT21NavIndicatorsTODO

Returns​

void

Defined in​

workingtitle-instruments-wt21/shared/Navigation/NavIndicators/NavIndicatorContext.ts:10