@microsoft/msfs-sdk

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

APAltCapDirectorActivationFunc

Ƭ APAltCapDirectorActivationFunc: (vs: number, targetAltitude: number, currentAltitude: number) => boolean

A function which returns true if the capturing shall be activated

Type declaration

▸ (vs, targetAltitude, currentAltitude): boolean

Parameters

Name	Type	Description
`vs`	`number`	Current vertical speed in [ft/min]
`targetAltitude`	`number`	Target altitude [ft]
`currentAltitude`	`number`	Current altitude [ft]

Returns

boolean

Defined in

src/sdk/autopilot/directors/APAltCapDirector.ts:51

APAltCapDirectorCaptureFunc

Ƭ APAltCapDirectorCaptureFunc: (targetAltitude: number, indicatedAltitude: number, initialFpa: number, tas: number) => number

A function which calculates a desired pitch angle, in degrees, to capture a target altitude.

Type declaration

▸ (targetAltitude, indicatedAltitude, initialFpa, tas): number

Parameters

Name	Type	Description
`targetAltitude`	`number`	The altitude to capture, in feet.
`indicatedAltitude`	`number`	The current indicated altitude, in feet.
`initialFpa`	`number`	The flight path angle of the airplane, in degrees, when altitude capture was first activated. Positive values indicate a descending path.
`tas`	`number`	The current true airspeed of the airplane, in knots.

Returns

number

Defined in

src/sdk/autopilot/directors/APAltCapDirector.ts:36

APAltCapDirectorOptions

Ƭ APAltCapDirectorOptions: Object

Options for APAltCapDirector.

Type declaration

Name	Type	Description
`captureAltitude`	`APAltCapDirectorCaptureFunc` \| `undefined`	An optional function that contains the logic for the capturing. Has to return the desired pitch as input for the pitch controller.
`shouldActivate`	`APAltCapDirectorActivationFunc` \| `undefined`	A function that returns true if the capturing shall start.

Defined in

src/sdk/autopilot/directors/APAltCapDirector.ts:13

APBackCourseDirectorInterceptFunc

Ƭ APBackCourseDirectorInterceptFunc: (distanceToSource: number, deflection: number, xtk: number, tas: number) => number

Calculates an intercept angle, in degrees, to capture the desired track from a localizer signal for APBackCourseDirector.

Type declaration

▸ (distanceToSource, deflection, xtk, tas): number

Parameters

Name	Type	Description
`distanceToSource`	`number`	The distance from the plane to the source of the navigation signal, in nautical miles.
`deflection`	`number`	The lateral deflection of the desired track relative to the plane, normalized from `-1` to `1`. Positive values indicate that the desired track is to the right of the plane.
`xtk`	`number`	The cross-track error of the plane from the desired track, in nautical miles. Positive values indicate that the plane is to the right of the track.
`tas`	`number`	The true airspeed of the plane, in knots.

Returns

number

Defined in

src/sdk/autopilot/directors/APBackCourseDirector.ts:96

APBackCourseDirectorOptions

Ƭ APBackCourseDirectorOptions: Object

Options for APBackCourseDirector.

Type declaration

Name	Type	Description
`bankRate?`	`number` \| () => `number`	The bank rate to enforce when the director commands changes in bank angle, in degrees per second, or a function which returns it. If not defined, a default bank rate will be used. Defaults to `undefined`.
`bankRateIntercept?`	`number` \| () => `number`	The bank rate to enforce when the director commands changes in bank angle during intercept phase, in degrees per second, or a function which returns it. If not defined, the bank rate defined by `bankRate` will be used. Defaults to `undefined`.
`bankRateTracking?`	`number` \| () => `number`	The bank rate to enforce when the director commands changes in bank angle during tracking phase, in degrees per second, or a function which returns it. If not defined, the bank rate defined by `bankRate` will be used. Defaults to `undefined`.
`desiredBankIntercept?`	(`trackError`: `number`) => `number`	A function which computes a desired bank angle to command for a given track error during intercept phase. The track error is the difference between the director's computed desired track and the airplane's actual ground track in the range `[-180, 180)` degrees. A positive error indicates that the shortest turn direction from the actual ground track toward the desired track is to the right. A positive bank angle indicates leftward bank. Defaults to a linear function which scales the track error by `2.5` to derive the desired bank angle.
`desiredBankTracking?`	(`trackError`: `number`) => `number`	A function which computes a desired bank angle to command for a given track error during tracking phase. The track error is the difference between the director's computed desired track and the airplane's actual ground track in the range `[-180, 180)` degrees. A positive error indicates that the shortest turn direction from the actual ground track toward the desired track is to the right. A positive bank angle indicates leftward bank. Defaults to a linear function which scales the track error by `1.25` to derive the desired bank angle.
`lateralInterceptCurve?`	`APBackCourseDirectorInterceptFunc`	A function used to translate DTK and XTK into a track intercept angle. If not defined, a function that computes a default curve tuned for slow GA aircraft will be used.
`lateralInterceptCurveIntercept?`	`APBackCourseDirectorInterceptFunc`	A function used to translate DTK and XTK into a track intercept angle during intercept phase. If not defined, the function defined by `lateralInterceptCurve` will be used instead. Defaults to `undefined`.
`lateralInterceptCurveTracking?`	`APBackCourseDirectorInterceptFunc`	A function used to translate DTK and XTK into a track intercept angle during tracking phase. If not defined, the function defined by `lateralInterceptCurve` will be used instead. Defaults to `undefined`.
`maxBankAngle?`	`number` \| () => `number`	The maximum bank angle, in degrees, supported by the director, or a function which returns it. If not defined, the director will use the maximum bank angle defined by its parent autopilot (via `apValues`). Defaults to `undefined`.
`maxBankAngleIntercept?`	`number` \| () => `number`	The maximum bank angle, in degrees, supported by the director during intercept phase, or a function which returns it. If not defined, the director will use the maximum bank angle defined by `maxBankAngle`. Defaults to `undefined`.
`maxBankAngleTracking?`	`number` \| () => `number`	The maximum bank angle, in degrees, supported by the director during tracking phase, or a function which returns it. If not defined, the director will use the maximum bank angle defined by `maxBankAngle`. Defaults to `undefined`.
`phaseOptions?`	`Readonly`<`APBackCourseDirectorPhaseOptions`>	Options with which to configure the default phase selector logic. Ignored if the `phaseSelector` option is specified.
`phaseSelector?`	`APBackCourseDirectorPhaseSelectorFunc`	A function which selects the phase for the director to use when it is active and tracking a navigation signal. If not defined, the director will use a default selector which can be configured using the `phaseOptions` option.

Defined in

src/sdk/autopilot/directors/APBackCourseDirector.ts:121

APBackCourseDirectorPhaseOptions

Ƭ APBackCourseDirectorPhaseOptions: Object

Options which which to configure APBackCourseDirector's default phase selection logic.

The director switches from intercept phase to tracking phase only when all tracking phase conditions are met. The director switches from tracking phase to intercept phase when any of the intercept phase conditions is met.

When the director is activated from an armed state, it will default to intercept phase unless all tracking phase conditions are met, in which case it will immediately enter tracking phase. The normal delay for entering tracking phase is ignored in this situation.

Type declaration

Name	Type	Description
`interceptCourseError?`	`number`	The minimum absolute value of the error between the course of the desired track and the airplane's actual ground track, in degrees, required to enter intercept phase. Defaults to `5`.
`interceptDeflection?`	`number`	The minimum absolute value of the lateral deflection of the desired track relative to the plane, normalized from `0` to `1`, required to enter intercept phase. Defaults to `0.25`.
`interceptSwitchDelay?`	`number`	The amount of time that the conditions for switching to intercept phase must be met, in milliseconds, before the director switches from tracking phase to intercept phase. Defaults to `5000`.
`interceptXtk?`	`number`	The minimum absolute value of the cross-track error of the plane from the desired track, in nautical miles, required to enter intercept phase. Defaults to `Infinity`.
`trackingCourseError?`	`number`	The maximum allowed absolute value of the error between the course of the desired track and the airplane's actual ground track, in degrees, required to enter intercept phase. Defaults to `2`.
`trackingDeflection?`	`number`	The maximum allowed absolute value of the lateral deflection of the desired track relative to the plane, normalized from `0` to `1`, required to enter tracking phase. Defaults to `0.125`.
`trackingSwitchDelay?`	`number`	The amount of time that the conditions for switching to tracking phase must be met, in milliseconds, before the director switches from intercept phase to tracking phase. Defaults to `5000`.
`trackingXtk?`	`number`	The maximum allowed absolute value of the cross-track error of the plane from the desired track, in nautical miles, required to enter intercept phase. Defaults to `Infinity`.

Defined in

src/sdk/autopilot/directors/APBackCourseDirector.ts:35

APBackCourseDirectorPhaseSelectorFunc

Ƭ APBackCourseDirectorPhaseSelectorFunc: (currentPhase: APBackCourseDirectorPhase | undefined, deflection: number, xtk: number, course: number, track: number) => APBackCourseDirectorPhase

Selects a phase for APBackCourseDirector to use while it is active and tracking a localizer signal.

Type declaration

▸ (currentPhase, deflection, xtk, course, track): APBackCourseDirectorPhase

Parameters

Name	Type	Description
`currentPhase`	`APBackCourseDirectorPhase` \| `undefined`	The current phase, or `undefined` if no phase has been selected since the last time the director was activated.
`deflection`	`number`	The lateral deflection of the desired track relative to the plane, normalized from `-1` to `1`. Positive values indicate that the desired track is to the right of the plane.
`xtk`	`number`	The cross-track error of the plane from the desired track, in nautical miles. Positive values indicate that the plane is to the right of the track.
`course`	`number`	The true course of the desired track, in degrees.
`track`	`number`	The actual true ground track of the airplane, in degrees.

Type declaration

▸ (gsAngleError, gsAngle, currentAngleRate, distance, height, groundSpeed, vs): number

Parameters

Name	Type	Description
`gsAngleError`	`number`	The glideslope angle error, in degrees, defined as the difference between the angle from the glideslope antenna to the airplane and the glideslope angle. Positive values indicate deviation of the airplane above the glideslope.
`gsAngle`	`number`	The glideslope angle, in degrees.
`currentAngleRate`	`number`	The current rate of change of glideslope angle error, in degrees per second.
`distance`	`number`	The lateral distance from the airplane to the glideslope antenna, in meters.
`height`	`number`	The height of the airplane above the glideslope antenna, in meters.
`groundSpeed`	`number`	The airplane's current ground speed, in meters per second.
`vs`	`number`	The airplane's current vertical speed, in meters per second.

Returns

number

Defined in

src/sdk/autopilot/directors/APGSDirector.ts:34

APGSDirectorOptions

Ƭ APGSDirectorOptions: Object

Options for APGSDirector.

Type declaration

Name	Type	Description
`angleClosureRate?`	`APGSDirectorAngleClosureRateFunc`	A function which returns the desired angle closure rate to track a glideslope. The angle closure rate is the rate of reduction of glideslope angle error. If not defined, the director will use a default angle closure rate curve. The output of this function will be overridden by the `vsTarget` function if the latter is defined.
`forceNavSource?`	`NavRadioIndex`	The index of the nav radio to force the director to use. If not defined, the director will use the nav radio specified by the active autopilot navigation source.
`maxVs?`	`number`	The maximum vertical speed the director can target, in feet per minute. Defaults to `0`.
`minVs?`	`number`	The minimum vertical speed the director can target, in feet per minute. Defaults to `-3000`.
`vsTarget?`	`APGSDirectorVsTargetFunc`	A function which returns the desired vertical speed target to track a glideslope. If defined, the output of this function will override that of the `angleClosureRate` function.

Defined in

src/sdk/autopilot/directors/APGSDirector.ts:70

APGSDirectorVsTargetFunc

Ƭ APGSDirectorVsTargetFunc: (gsAngleError: number, gsAngle: number, currentAngleRate: number, distance: number, height: number, groundSpeed: number, vs: number) => number

A function which calculates a desired vertical speed to target, in feet per minute, to track a glideslope.

Type declaration

▸ (gsAngleError, gsAngle, currentAngleRate, distance, height, groundSpeed, vs): number

Parameters

Name	Type	Description
`gsAngleError`	`number`	The glideslope angle error, in degrees, defined as the difference between the angle from the glideslope antenna to the airplane and the glideslope angle. Positive values indicate deviation of the airplane above the glideslope.
`gsAngle`	`number`	The glideslope angle, in degrees.
`currentAngleRate`	`number`	The current rate of change of glideslope angle error, in degrees per second.
`distance`	`number`	The lateral distance from the airplane to the glideslope antenna, in meters.
`height`	`number`	The height of the airplane above the glideslope antenna, in meters.
`groundSpeed`	`number`	The airplane's current ground speed, in meters per second.
`vs`	`number`	The airplane's current vertical speed, in meters per second.

Type declaration

▸ (distanceToSource, deflection, xtk, tas, isLoc): number

Parameters

Name	Type	Description
`distanceToSource`	`number`	The distance from the plane to the source of the navigation signal, in nautical miles.
`deflection`	`number`	The lateral deflection of the desired track relative to the plane, normalized from `-1` to `1`. Positive values indicate that the desired track is to the right of the plane.
`xtk`	`number`	The cross-track error of the plane from the desired track, in nautical miles. Positive values indicate that the plane is to the right of the track.
`tas`	`number`	The true airspeed of the plane, in knots.
`isLoc`	`boolean`	Whether the source of the navigation signal is a localizer.

Type declaration

▸ (currentPhase, deflection, xtk, course, track, isLoc, isInZoneOfConfusion): APNavDirectorPhase

Parameters

Name	Type	Description
`currentPhase`	`APNavDirectorPhase` \| `undefined`	The current phase, or `undefined` if no phase has been selected since the last time the director was activated.
`deflection`	`number`	The lateral deflection of the desired track relative to the plane, normalized from `-1` to `1`. Positive values indicate that the desired track is to the right of the plane.
`xtk`	`number`	The cross-track error of the plane from the desired track, in nautical miles. Positive values indicate that the plane is to the right of the track.
`course`	`number`	The true course of the desired track, in degrees.
`track`	`number`	The actual true ground track of the airplane, in degrees.
`isLoc`	`boolean`	Whether the source of the tracked navigation signal is a localizer.
`isInZoneOfConfusion`	`boolean`	Whether the source of the tracked navigation signal is a VOR and the airplane's position is close enough to the VOR to render lateral deflection values unreliable.

Defined in

src/sdk/instruments/RadioCommon.ts:16

AiracCycleFormatterFunction

Ƭ AiracCycleFormatterFunction: (cycle: AiracCycle) => string

An AIRAC cycle formatter function.

Type declaration

▸ (cycle): string

Parameters

Name	Type
`cycle`	`AiracCycle`

Returns

AltitudeConstraintSimple

Ƭ AltitudeConstraintSimple: Pick<VerticalData, "altDesc" | "altitude1" | "displayAltitude1AsFlightLevel">

Just the simple altitude constraint fields from the VerticalData interface.

Defined in

src/sdk/flightplan/FlightPlanning.ts:316

AltitudeSelectManagerOptions

Ƭ AltitudeSelectManagerOptions: Object

Configuration options for AltitudeSelectManager.

Type declaration

Name	Type	Description
`accelFilter?`	`number`	Bitflags to use to filter input events for input acceleration. Only events that pass the filter are eligible to trigger input acceleration. Defaults to `AltitudeSelectManagerAccelFilter.All`.
`accelInputCountThreshold?`	`number`	The required number of consecutive small-increment inputs received to trigger input acceleration. While acceleration is active, small-increment inputs will be converted to large increments. A threshold less than or equal to zero effectively disables input acceleration. Defaults to 0.
`accelResetOnDirectionChange?`	`boolean`	Whether to reset input acceleration if the direction of increment changes. Defaults to `false`.
`altitudeHoldSlotIndex?`	`1` \| `2` \| `3`	The altitude hold slot index to use. Defaults to 1.
`incrLarge`	`NumberUnitInterface`<`Distance`>	The value to increase/decrease the selected altitude setting on a large increment.
`incrLargeMetric?`	`NumberUnitInterface`<`Distance`>	The value to increase/decrease the selected altitude setting on a large increment in metric mode. If undefined, it will be set equal to the large increment value in non-metric mode.
`incrSmall`	`NumberUnitInterface`<`Distance`>	The value to increase/decrease the selected altitude setting on a small increment.
`incrSmallMetric?`	`NumberUnitInterface`<`Distance`>	The value to increase/decrease the selected altitude setting on a small increment in metric mode. If undefined, it will be set equal to the small increment value in non-metric mode.
`initOnInput?`	`boolean`	Whether to initialize the selected altitude setting only on the first detected input. If `false`, the selected altitude will be initialized as soon as the manager is fully initialized. Defaults to `false`.
`initToIndicatedAlt?`	`boolean`	Whether to initialize the selected altitude setting to the indicated altitude. If `false`, the selected altitude will be initialized to `0`. Defaults to `false`.
`inputIncrLargeThreshold`	`number`	The threshold for an altitude select change key input value above which the input is interpreted as a large increment.
`lockAltToStepOnIncr?`	`boolean`	Whether to lock the selected altitude setting to multiples of the appropriate increment value on a small or large increment. Defaults to `true`.
`lockAltToStepOnIncrMetric?`	`boolean`	Whether to lock the selected altitude setting to multiples of the appropriate increment value on a small or large increment in metric mode. If undefined, it will be set equal to the lock flag in non-metric mode.
`lockAltToStepOnSet?`	`boolean`	Whether to lock the selected altitude setting to multiples of the small increment on a SET event. Defaults to `false`.
`lockAltToStepOnSetMetric?`	`boolean`	Whether to lock the selected altitude setting to multiples of the small increment in metric mode on a SET event. If undefined, it will be set equal to the lock flag in non-metric mode.
`maxValue`	`NumberUnitInterface`<`Distance`>	The maximum value of the selected altitude setting.
`maxValueMetric?`	`NumberUnitInterface`<`Distance`>	The maximum value of the selected altitude setting in metric mode. If undefined, it will be set equal to the maximum value in non-metric mode.
`minValue`	`NumberUnitInterface`<`Distance`>	The minimum value of the selected altitude setting.
`minValueMetric?`	`NumberUnitInterface`<`Distance`>	The minimum value of the selected altitude setting in metric mode. If undefined, it will be set equal to the minimum value in non-metric mode.
`supportMetric`	`boolean`	Whether to support metric mode.
`transformSetToIncDec?`	`boolean`	Whether to treat all intercepted SET key events as if they were INC or DEC events. Defaults to `true`.

Defined in

src/sdk/autopilot/managers/AltitudeSelectManager.ts:53

AnimatorEasingFunc

Ƭ AnimatorEasingFunc: (start: number, stop: number, progress: number) => number

An easing function used by Animator.

Type declaration

▸ (start, stop, progress): number

Parameters

Name	Type
`start`	`number`
`stop`	`number`
`progress`	`number`

Ƭ ArrayType<A>: A extends ReadonlyArray<infer T> ? T : never

Gets the element type of an array.

Type parameters

Name	Type
`A`	extends `ReadonlyArray`<`any`>

Defined in

src/sdk/utils/datastructures/ArrayUtils.ts:4

ArrivalProcedure

Ƭ ArrivalProcedure: Procedure

src/sdk/autothrottle/Autothrottle.ts:4

AutothrottleThrottleInfo

Ƭ AutothrottleThrottleInfo: Object

Information describing a throttle controlled by an autothrottle system.

Type declaration

Name	Type	Description
`idlePosition`	`number`	The idle position of the throttle, where `-1` is full reverse, `0` is neutral, and `1` is full forward.
`index`	`AutothrottleThrottleIndex`	The index of the engine controlled by the throttle.
`isVirtual`	`boolean`	Whether the throttle is a virtual throttle.
`maxThrustPosition`	`number`	The maximum thrust position of the throttle, where `-1` is full reverse, `0` is neutral, and `1` is full forward.

Defined in

src/sdk/autothrottle/AbstractAutothrottle.ts:23

AvionicsSystemPowerEvents

Ƭ AvionicsSystemPowerEvents: { [K in keyof ElectricalEvents]: ElectricalEvents[K] extends boolean ? ElectricalEvents[K] : never }

Type declaration

Name	Type	Description
`index`	`number`	The index of the COM radio to update.
`spacing`	`ComSpacing`	The spacing of the COM radio.

Defined in

src/sdk/instruments/RadioCommon.ts:95

CombinedSubscribableInputs

Ƭ CombinedSubscribableInputs<Types>: { [Index in keyof Types]: Subscribable<Types[Index]> } & TupleLength<Types>

A type which maps a tuple of input types to a tuple of subscribables that provide the input types.

Type parameters

Name	Type
`Types`	extends readonly `any`[]

Defined in

src/sdk/sub/CombinedSubject.ts:14

CompiledMapSystem

Ƭ CompiledMapSystem<Modules, Layers, Controllers, Context>: Object

A compiled map from MapSystemBuilder.

Type parameters

Name	Type
`Modules`	extends `ModuleRecord`
`Layers`	extends `LayerRecord`
`Controllers`	extends `ControllerRecord`
`Context`	extends `ContextRecord`

Type declaration

Name	Type	Description
`context`	`MapSystemContext`<`Modules`, `Layers`, `Controllers`, `Context`>	The compiled map context.
`map`	`VNode`	The compiled map, rendered as a VNode.
`ref`	`NodeReference`<`MapSystemComponent`<`MapSystemComponentProps`<`Modules`>>>	A reference to the compiled map.

Defined in

src/sdk/components/mapsystem/MapSystemTypes.ts:82

ContextRecord

Ƭ ContextRecord: Record<string, any>

src/sdk/components/mapsystem/MapSystemTypes.ts:20

ControllerUnion

Ƭ ControllerUnion<Controllers, New>: Omit<Controllers, keyof New> & New

Adds all controllers from a new layer record to an existing record. Controllers from the new record will overwrite the ones in the existing record if there are key collisions.

Type parameters

Name	Type
`Controllers`	extends `ControllerRecord`
`New`	extends `ControllerRecord`

Defined in

src/sdk/components/mapsystem/MapSystemTypes.ts:48

DateTimeFormatterOptions

Ƭ DateTimeFormatterOptions: Object

Options for creating a time formatter.

Type declaration

Name	Type	Description
`cache`	`boolean`	Whether to cache and reuse the previously generated string when possible.
`dayNames`	[`string`, `string`, `string`, `string`, `string`, `string`, `string`]	Names for days of the week, starting with Sunday.
`dayNamesShort`	[`string`, `string`, `string`, `string`, `string`, `string`, `string`]	Abbreviated names for days of the week, starting with Sunday.
`monthNames`	[`string`, `string`, `string`, `string`, `string`, `string`, `string`, `string`, `string`, `string`, `string`, `string`]	Names for months, starting with January.
`monthNamesShort`	[`string`, `string`, `string`, `string`, `string`, `string`, `string`, `string`, `string`, `string`, `string`, `string`]	Abbreviated names for months, starting with January.
`nanString`	`string`	The string to output for an input of `NaN`.

Defined in

src/sdk/graphics/text/DateTimeFormatter.ts:6

DepartureProcedure

Ƭ DepartureProcedure: Procedure

A departure procedure (SID).

Defined in

src/sdk/navigation/Facilities.ts:361

DisplayComponentFactory

Ƭ DisplayComponentFactory<P, Contexts>: (props: P) => DisplayComponent<P, Contexts>

A constructor signature for a DisplayComponent.

Type parameters

Name	Type
`P`	extends `ComponentProps`
`Contexts`	extends `Context`<`unknown`>[] = []

Type declaration

• (props): DisplayComponent<P, Contexts>

Parameters

Name	Type
`props`	`P`

Defined in

src/sdk/instruments/Electrical.ts:119

EmptyRecord

Ƭ EmptyRecord: Record<never, never>

An empty record.

Defined in

src/sdk/components/mapsystem/MapSystemTypes.ts:30

EngineEvents

Ƭ EngineEvents<E>: BaseEngineEvents & IndexedEvents<EngineIndexedTopics, NumberToRangeUnion<E>> & EngineIndexedEvents

Events related to the planes engines.

Type parameters

Name	Type
`E`	extends `number` = `number`

Defined in

src/sdk/instruments/EngineData.ts:144

ExtendedApproachType

Ƭ ExtendedApproachType: ApproachType | AdditionalApproachType

src/sdk/utils/predictions/FlightPlanPredictionProvider.ts:8

FacilitySearchTypeLatLon

Facility search types for facilities with a defined latitude and longitude.

Defined in

src/sdk/navigation/FacilityLoader.ts:22

FacilityTypeMap

Ƭ FacilityTypeMap: Object

A type map of FacilityType enum to facility type.

Type declaration

Name	Type	Description
`LOAD_AIRPORT`	`AirportFacility`	Airport facility.
`LOAD_INTERSECTION`	`IntersectionFacility`	Intersection facility.
`LOAD_NDB`	`NdbFacility`	NDB facility.
`LOAD_VOR`	`VorFacility`	VOR facility.
`RWY`	`RunwayFacility`	Runway waypoint facility.
`USR`	`UserFacility`	User waypoint facility.
`VIS`	`VisualFacility`	Visual approach waypoint facility.

Defined in

src/sdk/navigation/Facilities.ts:885

FadecEvents

Ƭ FadecEvents: Object

FADEC-related events.

Index signature

▪ [fadec_mode: IndexedEventType<"fadec_mode">]: string

The name of the currently active FADEC mode.

Type declaration

Name	Type	Description
`fadec_active`	`boolean`	Whether FADEC is active.

Defined in

src/sdk/fadec/FadecEvents.ts:6

FamilyOfUnit

Ƭ FamilyOfUnit<U>: U extends Unit<infer T> ? T : never

Utility type to get the family of a unit type.

Type parameters

Name	Type
`U`	extends `Unit`<`string`>

Defined in

src/sdk/math/NumberUnit.ts:5

FlattenArray

Ƭ FlattenArray<A>: A extends ReadonlyArray<infer T> ? T extends ReadonlyArray<infer T1> ? T1 : T[] : never

Flattens an array type to a depth of 1.

Type parameters

Name	Type
`A`	extends `ReadonlyArray`<`any`>

Defined in

src/sdk/utils/datastructures/ArrayUtils.ts:9

FlattenArrayToDepth

Ƭ FlattenArrayToDepth<A, Depth>: Depth extends 0 ? A : Depth extends 1 ? FlattenArray<A> : Depth extends 2 ? FlattenArrayToDepth<FlattenArray<A>, 1> : Depth extends 3 ? FlattenArrayToDepth<FlattenArray<A>, 2> : Depth extends 4 ? FlattenArrayToDepth<FlattenArray<A>, 3> : Depth extends 5 ? FlattenArrayToDepth<FlattenArray<A>, 4> : Depth extends 6 ? FlattenArrayToDepth<FlattenArray<A>, 5> : Depth extends 7 ? FlattenArrayToDepth<FlattenArray<A>, 6> : Depth extends 8 ? FlattenArrayToDepth<FlattenArray<A>, 7> : Depth extends 9 ? FlattenArrayToDepth<FlattenArray<A>, 8> : Depth extends 10 ? FlattenArrayToDepth<FlattenArray<A>, 9> : never

Flattens an array type to a depth between 0 and 10, inclusive.

Type parameters

Name	Type
`A`	extends `ReadonlyArray`<`any`>
`Depth`	extends `0` \| `1` \| `2` \| `3` \| `4` \| `5` \| `6` \| `7` \| `8` \| `9` \| `10`

Defined in

src/sdk/utils/datastructures/ArrayUtils.ts:14

FlightPathBankAngleBreakpoints

Ƭ FlightPathBankAngleBreakpoints: readonly readonly [bankAngle: number, speed: number][]

An array of breakpoints defining a lookup table for bank angle, in degrees, versus airplane speed, in knots.

Defined in

src/sdk/flightplan/FlightPathCalculator.ts:25

FlightPathCalculatorControlEventsForId

Ƭ FlightPathCalculatorControlEventsForId<ID>: { [P in keyof BaseFlightPathCalculatorControlEvents as `${P}${FlightPathCalculatorControlEventSuffix<ID>}`]: BaseFlightPathCalculatorControlEvents[P] }

Events used to control a flight path calculator with a specific ID.

Type parameters

Name	Type
`ID`	extends `string`

Defined in

src/sdk/flightplan/FlightPathCalculatorControlEvents.ts:19

FlightPathCalculatorInitOptions

Ƭ FlightPathCalculatorInitOptions: FlightPathCalculatorOptions & { id?: string ; initSyncRole?: "none" | "primary" | "replica" }

Options with which to initialize a FlightPathCalculator.

Defined in

src/sdk/flightplan/FlightPathCalculator.ts:94

FlightPathLegLineStyle

Ƭ FlightPathLegLineStyle: Object

A style definition for a line rendered by FlightPathLegLineRenderer.

Type declaration

Name	Type	Description
`isContinuous`	`boolean`	Whether the line is continuous with the last vector.
`outlineDash`	readonly `number`[] \| `null`	The dash array of the line outline, or `null` if the outline is solid.
`outlineStyle`	`string` \| `CanvasPattern` \| `CanvasGradient`	The style of the line outline.
`outlineWidth`	`number`	The width of the line outline, in pixels. A width of zero or less will cause the outline to not be rendered.
`strokeDash`	readonly `number`[] \| `null`	The dash array of the line stroke, or `null` if the stroke is solid.
`strokeStyle`	`string` \| `CanvasPattern` \| `CanvasGradient`	The style of the line stroke.
`strokeWidth`	`number`	The width of the line stroke, in pixels. A width of zero or less will cause the stroke to not be rendered.

Defined in

src/sdk/components/map/FlightPathLegLineRenderer.ts:10

FlightPathLegLineStyleSelector

Ƭ FlightPathLegLineStyleSelector<Args>: (vector: CircleVector, isIngress: boolean, isEgress: boolean, leg: LegDefinition, projection: GeoProjection, out: FlightPathLegLineStyle, ...args: Args) => FlightPathLegLineStyle

A function which selects a line style for a rendered vector.

Type parameters

Name	Type
`Args`	extends `any`[]

Type declaration

▸ (vector, isIngress, isEgress, leg, projection, out, ...args): FlightPathLegLineStyle

Parameters

Name	Type	Description
`vector`	`CircleVector`	The vector for which to select a style.
`isIngress`	`boolean`	Whether the vector is part of the ingress transition.
`isEgress`	`boolean`	Whether the vector is part of the egress transition.
`leg`	`LegDefinition`	The flight plan leg containing the vector to render.
`projection`	`GeoProjection`	The map projection to use when rendering.
`out`	`FlightPathLegLineStyle`	The line style object to which to write the selected style.
`...args`	`Args`	Additional arguments.

Returns

FlightPathLegLineStyle

Defined in

src/sdk/components/map/FlightPathLegLineRenderer.ts:44

FlightPathLegPatternStyle

Ƭ FlightPathLegPatternStyle: Object

A style definition for a pattern rendered by FlightPathLegPatternRenderer.

Type declaration

Name	Type	Description
`isContinuous`	`boolean`	Whether the pattern is continuous with the previous vector.
`pattern`	`PathPattern` \| `null`	The pattern to render.

Defined in

src/sdk/components/map/FlightPathLegPatternRenderer.ts:11

FlightPathLegPatternStyleSelector

Ƭ FlightPathLegPatternStyleSelector<Args>: (vector: CircleVector, isIngress: boolean, isEgress: boolean, leg: LegDefinition, projection: GeoProjection, out: FlightPathLegPatternStyle, ...args: Args) => FlightPathLegPatternStyle

A function which selects a pattern style for a rendered vector.

Type parameters

Name	Type
`Args`	extends `any`[]

Type declaration

▸ (vector, isIngress, isEgress, leg, projection, out, ...args): FlightPathLegPatternStyle

Parameters

Name	Type	Description
`vector`	`CircleVector`	The vector for which to select a style.
`isIngress`	`boolean`	Whether the vector is part of the ingress transition.
`isEgress`	`boolean`	Whether the vector is part of the egress transition.
`leg`	`LegDefinition`	The flight plan leg containing the vector to render.
`projection`	`GeoProjection`	The map projection to use when rendering.
`out`	`FlightPathLegPatternStyle`	The pattern style object to which to write the selected style.
`...args`	`Args`	Additional arguments.

Ƭ FlightPlanModBatch: Object

A flight plan modification batch.

Type declaration

Name	Type	Description
`name?`	`string`	This batch's name.
`uuid`	`string`	This batch's unique ID.

Defined in

src/sdk/flightplan/FlightPlan.ts:46

FlightPlannerEvents

Ƭ FlightPlannerEvents: BaseFlightPlannerEvents & FlightPlannerEventsForId<string>

src/sdk/instruments/FlightTimer.ts:100

FlightTimerControlEventsForId

Ƭ FlightTimerControlEventsForId<ID>: { [P in keyof BaseFlightTimerControlEvents as `${P}${FlightTimerEventSuffix<ID>}_${number}`]: BaseFlightTimerControlEvents[P] }

Events used to control flight timers with a specific ID, keyed by indexed topic names.

Type parameters

Name	Type
`ID`	extends `string`

Defined in

src/sdk/instruments/FlightTimer.ts:93

FlightTimerEventSuffix

Ƭ FlightTimerEventSuffix<ID>: ID extends "" ? "" : `_${ID}`

The event topic suffix for a flight timer with a specific ID.

Type parameters

Name	Type
`ID`	extends `string`

Defined in

src/sdk/instruments/FlightTimer.ts:22

FlightTimerEvents

Ƭ FlightTimerEvents: FlightTimerEventsForId<""> & FlightTimerEventsForId<string>

src/sdk/fmc/FmcRenderer.ts:42

FmcFormatter

Ƭ FmcFormatter<T>: Formatter<T, FmcFormatterOutput>

A formatter for use in the FMC Framework

Type parameters

Name
`T`

Type declaration

▸ (output, render, atRowIndex): void

Parameters

Name	Type
`output`	`FmcOutputTemplate`
`render`	`FmcRenderTemplate`
`atRowIndex`	`number`

Returns

void

Defined in

src/sdk/fmc/AbstractFmcPage.ts:13

FmcRenderTemplate

Ƭ FmcRenderTemplate: FmcRenderTemplateRow[]

Type for FMC rendering data

Defined in

src/sdk/fmc/FmcRenderer.ts:39

FmcRenderTemplateColumn

Ƭ FmcRenderTemplateColumn: string | FmcComponent | PositionedFmcColumn

Type for FMC column rendering data

Defined in

src/sdk/fmc/FmcRenderer.ts:5

FmcRenderTemplateRow

Ƭ FmcRenderTemplateRow: FmcRenderTemplateColumn[]

Type for FMC row rendering data

Defined in

src/sdk/fmc/FmcRenderer.ts:36

FragmentFactory

Ƭ FragmentFactory: (props: ComponentProps) => DisplayChildren[] | undefined

A type for the Fragment function.

Type declaration

▸ (props): DisplayChildren[] | undefined

Parameters

Name	Type
`props`	`ComponentProps`

Defined in

src/sdk/geo/GeoCircleResampler.ts:53

GeoCircleResamplerHandler

Ƭ GeoCircleResamplerHandler: (vector: Readonly<GeoCircleResamplerVector>) => void

A function which handles resampled points.

Type declaration

▸ (vector): void

Parameters

Name	Type	Description
`vector`	`Readonly`<`GeoCircleResamplerVector`>	A vector which describes the projected path terminating at the resampled point.

Ƭ GeoKdTreeSearchFilter<T>: (element: T, point: ReadonlyFloat64Array, distance: number, queryPoint: ReadonlyFloat64Array) => boolean

A filtering function for k-d tree searches.

Type parameters

Name
`T`

Type declaration

▸ (element, point, distance, queryPoint): boolean

Parameters

Name	Type	Description
`element`	`T`	A candidate search result.
`point`	`ReadonlyFloat64Array`	The location of the candidate search result, in cartesian form.
`distance`	`number`	The great-circle distance, in great-arc radians, from the candidate search result to the query point.
`queryPoint`	`ReadonlyFloat64Array`	The query point, in cartesian form.

Returns

boolean

Defined in

src/sdk/utils/datastructures/GeoKdTree.ts:23

GeoKdTreeSearchVisitor

Ƭ GeoKdTreeSearchVisitor<T>: (element: T, point: ReadonlyFloat64Array, distance: number, queryPoint: ReadonlyFloat64Array) => boolean

A visitor function for geo k-d tree searches.

Type parameters

Name
`T`

Type declaration

▸ (element, point, distance, queryPoint): boolean

Parameters

Name	Type	Description
`element`	`T`	A search result.
`point`	`ReadonlyFloat64Array`	The location of the search result, in cartesian form.
`distance`	`number`	The great-circle distance, in great-arc radians, from the search result to the query point.
`queryPoint`	`ReadonlyFloat64Array`	The query point, in cartesian form.

Returns

boolean

Defined in

src/sdk/utils/datastructures/GeoKdTree.ts:13

GeodesicResamplerHandler

Ƭ GeodesicResamplerHandler: (point: GeoPointInterface, projected: Float64Array, index: number) => void

A function which handles resampled points.

Type declaration

▸ (point, projected, index): void

Parameters

Name	Type
`point`	`GeoPointInterface`
`projected`	`Float64Array`
`index`	`number`

Type parameters

Name
`T`

Type declaration

▸ (data): void

Parameters

Name	Type
`data`	`T`

Returns

void

Defined in

src/sdk/data/EventBus.ts:7

HorizonProjectionParameters

Ƭ HorizonProjectionParameters: Object

A parameter object for HorizonProjection.

Type declaration

Name	Type	Description
`altitude?`	`number`	The altitude of the airplane, in meters above mean sea level.
`fov?`	`number`	The field of view, in degrees.
`fovEndpoints?`	`ReadonlyFloat64Array`	The projected endpoints at which to measure the field of view, as `[x1, y1, x2, y2]`, with each component expressed relative to the width or height of the projected window.
`heading?`	`number`	The true heading of the airplane, in degrees.
`headingScaleFactor?`	`number`	The factor by which to scale relative heading angles when projecting points. The relative heading angle of a point is the difference between the bearing of the point from the airplane and the airplane's heading. A scaling factor of 1 leaves points unchanged. Factors less than 1 cause points to be projected closer to the lubber line. Factors greater than 1 cause points to be projected farther from the lubber line.
`offset?`	`ReadonlyFloat64Array`	The offset of the projection camera relative to the airplane, as `[x, y, z]` in meters using the airplane's coordinate system. The positive z axis points in the forward direction of the airplane, the positive x axis points in the upward direction, and the positive y axis points to the right.
`pitch?`	`number`	The pitch of the airplane, in degrees.
`pitchScaleFactor?`	`number`	The factor by which to scale relative zero-roll pitch angles when projecting points. The relative zero-roll pitch angle of a point is the pitch angle of the point relative to the camera if the airplane had zero degrees of roll. A scaling factor of 1 leaves points unchanged. Factors less than 1 cause points to be projected closer to the pitch line corresponding to the airplane's pitch. Factors greater than 1 cause points to be projected farther from the pitch line corresponding to the airplane's pitch.
`position?`	`LatLonInterface`	The position of the airplane.
`projectedOffset?`	`ReadonlyFloat64Array`	The offset of the center of the projection, as `[x, y]` in pixels.
`projectedSize?`	`ReadonlyFloat64Array`	The size of the projected window, as `[x, y]` in pixels.
`roll?`	`number`	The roll of the airplane, in degrees.

Defined in

src/sdk/components/horizon/HorizonProjection.ts:14

HydraulicsEvents

Ƭ HydraulicsEvents: BaseHydraulicsSystemEvents & HydraulicsIndexedEvents

Type declaration

Name	Type	Description
`n1`	`number`	The current N1 value of the engine, in percent.
`n1Corrected`	`number`	The current corrected N1 value of the engine, in percent.
`throttle`	`number`	The current engine throttle setting, in the range of -1 to +1.
`throttleLeverPos`	`number`	The current engine throttle lever position, in the range of -1 to +1.
`thrust`	`number`	The current net thrust delivered by the engine, in pounds.

Defined in

src/sdk/fadec/JetFadec.ts:64

JetFadecThrottleInfo

Ƭ JetFadecThrottleInfo: Object

Information for a throttle controlled by a jet FADEC.

Type declaration

Name	Type	Description
`index`	`number`	The index of the engine controlled by the throttle.
`leverPosTopic`	`string`	The event bus topic that emits the throttle's virtual lever position.
`visiblePosSimVar`	`string`	The name of the SimVar controlling the throttle's visible lever position.

Defined in

src/sdk/fadec/JetFadec.ts:50

JetFadecThrottleInfoInternal

Ƭ JetFadecThrottleInfoInternal: JetFadecThrottleInfo & { correctedN1SimVar: string ; fadecModeTopic: IndexedEventType<"fadec_mode"> ; n1SimVar: string ; throttleSimVar: string ; thrustSimVar: string }

Information for a throttle controlled by a jet FADEC, for internal use.

Defined in

src/sdk/fadec/JetFadec.ts:84

KdTreeSearchFilter

Ƭ KdTreeSearchFilter<T>: (element: T, key: ReadonlyFloat64Array, distance: number, queryKey: ReadonlyFloat64Array, queryElement: T | undefined) => boolean

A filtering function for k-d tree searches.

Type parameters

Name
`T`

Type declaration

▸ (element, key, distance, queryKey, queryElement): boolean

Parameters

Name	Type	Description
`element`	`T`	A candidate search result.
`key`	`ReadonlyFloat64Array`	The key of the candidate search result.
`distance`	`number`	The distance from the candidate search result's key to the query key.
`queryKey`	`ReadonlyFloat64Array`	The query key.
`queryElement`	`T` \| `undefined`	The query element, or undefined if the search was initiated directly from a key.

Returns

boolean

Defined in

src/sdk/utils/datastructures/KdTree.ts:24

KdTreeSearchVisitor

Ƭ KdTreeSearchVisitor<T>: (element: T, key: ReadonlyFloat64Array, distance: number, queryKey: ReadonlyFloat64Array, queryElement: T | undefined) => boolean

A visitor function for k-d tree searches.

Type parameters

Name
`T`

Type declaration

▸ (element, key, distance, queryKey, queryElement): boolean

Parameters

Name	Type	Description
`element`	`T`	A search result.
`key`	`ReadonlyFloat64Array`	The key of the search result.
`distance`	`number`	The distance from the search result's key to the query key.
`queryKey`	`ReadonlyFloat64Array`	The query key.
`queryElement`	`T` \| `undefined`	The query element, or undefined if the search was initiated directly from a key.

Param

The cross-track error, in nautical miles. Negative values indicate that the plane is to the left of the desired track.

Param

The true airspeed of the plane, in knots.

Defined in

src/sdk/autopilot/directors/LNavDirector.ts:21

LNavDirectorOptions

Ƭ LNavDirectorOptions: Object

Options for LNavDirector.

Type declaration

Name	Type	Description
`bankRate?`	`number` \| () => `number`	The bank rate to enforce when the director commands changes in bank angle, in degrees per second, or a function which returns it. If not undefined, a default bank rate will be used. Defaults to `undefined`.
`disableArming?`	`boolean`	Whether to disable arming on the director. If `true`, the director will always skip the arming phase and instead immediately activate itself when requested. Defaults to `false`.
`disableAutoSuspendAtMissedApproachPoint?`	`boolean`	Whether to disable auto-suspend at the missed approach point. If `true`, the director will not suspend sequencing once the missed approach point is the active leg. Defaults to `false`.
`hasVectorAnticipation?`	`boolean`	Whether the director supports vector anticipation. If `true`, the director will begin tracking the next flight path vector in advance based on the predicted amount of time required to transition to the new bank angle required to track the upcoming vector. Defaults to `false`.
`lateralInterceptCurve?`	`LNavDirectorInterceptFunc`	A function used to translate DTK and XTK into a track intercept angle. If not defined, a function that computes a default curve tuned for slow GA aircraft will be used.
`maxBankAngle?`	`number` \| () => `number`	The maximum bank angle, in degrees, supported by the director, or a function which returns it. If not defined, the director will use the maximum bank angle defined by its parent autopilot (via `apValues`). Defaults to `undefined`.
`minimumActivationAltitude?`	`number`	The minimum radio altitude, in feet, required for the director to activate, or `undefined` if there is no minimum altitude. Defaults to `undefined`.
`vectorAnticipationBankRate?`	`number`	The bank rate used to determine the vector anticipation distance, in degrees per second. Ignored if `hasVectorAnticipation` is `false`. Defaults to `5`.

Defined in

src/sdk/autopilot/directors/LNavDirector.ts:26

LNavInterceptFunc

Ƭ LNavInterceptFunc: (dtk: number, xtk: number, tas: number) => number

Calculates an intercept angle, in degrees, to capture the desired GPS track for LNavComputer.

Type declaration

▸ (dtk, xtk, tas): number

Parameters

Name	Type	Description
`dtk`	`number`	The desired track, in degrees true.
`xtk`	`number`	The cross-track error, in nautical miles. Positive values indicate that the plane is to the right of the desired track.
`tas`	`number`	The true airspeed of the plane, in knots.

Ƭ LNavState: Object

An object describing an LNAV tracking state.

Type declaration

Name	Type	Description
`globalLegIndex`	`number`	The global index of the tracked flight plan leg.
`inhibitedSuspendLegIndex`	`number`	The global index of the flight plan leg for which suspend is inhibited, or `-1` if there is no such leg.
`isMissedApproachActive`	`boolean`	Whether the missed approach is active.
`isSuspended`	`boolean`	Whether leg sequencing is suspended.
`resetVectorsOnSuspendEnd`	`boolean`	Whether to reset the tracked vector to the beginning of the suspended leg once suspend ends.
`transitionMode`	`LNavTransitionMode`	The transition mode.
`vectorIndex`	`number`	The index of the tracked flight path vector.

Defined in

src/sdk/autopilot/lnav/LNavTypes.ts:43

LNavSteerCommand

Ƭ LNavSteerCommand: Object

A steering command generated by LNAV.

Type declaration

Name	Type	Description
`desiredBankAngle`	`number`	The desired bank angle, in degrees. Positive values indicate left bank.
`dtk`	`number`	The current desired track, in degrees true.
`isValid`	`boolean`	Whether this command is valid.
`tae`	`number`	The current track angle error, in degrees in the range `[-180, 180)`.
`xtk`	`number`	The current cross-track error, in nautical miles. Positive values indicate that the plane is to the right of the desired track.

Defined in

src/sdk/autopilot/lnav/LNavTypes.ts:69

LNavTrackingState

Ƭ LNavTrackingState: Object

A LNAV tracking state.

Type declaration

Name	Type	Description
`globalLegIndex`	`number`	The global index of the tracked flight plan leg.
`isSuspended`	`boolean`	Whether LNAV sequencing is suspended.
`isTracking`	`boolean`	Whether LNAV is currently tracking a flight path.
`transitionMode`	`LNavTransitionMode`	The LNAV transition mode.
`vectorIndex`	`number`	The index of the tracked flight path vector.

Defined in

src/sdk/autopilot/lnav/LNavEvents.ts:141

LayerRecord

Ƭ LayerRecord: Record<string, any>

A record of string-keyed map layers.

Defined in

src/sdk/components/mapsystem/MapSystemTypes.ts:15

LayerUnion

Ƭ LayerUnion<Layers, New>: Omit<Layers, keyof New> & New

Adds all modules from a new layer record to an existing record. Layers from the new record will overwrite the ones in the existing record if there are key collisions.

Type parameters

Name	Type
`Layers`	extends `LayerRecord`
`New`	extends `LayerRecord`

Defined in

src/sdk/components/mapsystem/MapSystemTypes.ts:42

LegPredictions

Ƭ LegPredictions: PassedLegPredictions | ActiveOrUpcomingLegPredictions

Leg predictions data, either passed or active/upcoming

Defined in

src/sdk/utils/predictions/LegPredictions.ts:74

LegStyleHandler

Ƭ LegStyleHandler: (plan: FlightPlan, leg: LegDefinition, activeLeg: LegDefinition | undefined, legIndex: number, activeLegIndex: number) => FlightPathRenderStyle | FlightPathVectorStyle

A handler that takes some leg data and returns the appropriate flight path rendering style.

Type declaration

▸ (plan, leg, activeLeg, legIndex, activeLegIndex): FlightPathRenderStyle | FlightPathVectorStyle

Parameters

Name	Type
`plan`	`FlightPlan`
`leg`	`LegDefinition`
`activeLeg`	`LegDefinition` \| `undefined`
`legIndex`	`number`
`activeLegIndex`	`number`

Returns

FlightPathRenderStyle | FlightPathVectorStyle

Defined in

src/sdk/components/mapsystem/MapSystemPlanRenderer.ts:17

LegWaypointHandler

Ƭ LegWaypointHandler: (plan: FlightPlan, leg: LegDefinition, activeLeg: LegDefinition | null, legIndex: number, activeLegIndex: number) => number

A handler that takes some leg data and returns the waypoint rendering role that the waypoint should be rendered under.

Type declaration

▸ (plan, leg, activeLeg, legIndex, activeLegIndex): number

Parameters

Name	Type
`plan`	`FlightPlan`
`leg`	`LegDefinition`
`activeLeg`	`LegDefinition` \| `null`
`legIndex`	`number`
`activeLegIndex`	`number`

Returns

LocalizerFrequency

Ƭ LocalizerFrequency: Object

whether a nav source is tuned to a localizer frequency.

Type declaration

Name	Type	Description
`isLocalizer`	`boolean`	if the freq is a loc
`source`	`NavSourceId`	the nav source id

Defined in

src/sdk/instruments/NavProcessor.ts:308

LodBoundaryShape

Ƭ LodBoundaryShape: LodBoundaryVector[]

A single contiguous boundary shape.

Defined in

src/sdk/navigation/LodBoundary.ts:20

LodBoundaryVector

Ƭ LodBoundaryVector: Object

A vector describing one edge of a boundary shape.

Type declaration

Name	Type	Description
`circle?`	`GeoCircle`	The path of this vector, or undefined if this is a starting vector.
`end`	`GeoPointInterface`	The end point of this vector.

Defined in

src/sdk/navigation/LodBoundary.ts:9

LogicHandler

Ƭ LogicHandler<T>: Object

A type that pairs a logic element with its callback handler.

Type parameters

Name
`T`

Type declaration

Name	Type	Description
`handler`	(`data`: `T`) => `void`	A handler to call back to when there's a value change.
`logic`	`CompositeLogicXMLElement`	A logic element instance to evaluate.
`precision?`	`number`	A precision to use for numeric values.
`smoothFactor?`	`number`	A linear smoothing factor for value changes.

Type declaration

Name	Type	Description
`range`	`number`	The range of the field of view, in great-arc radians.
`target`	`GeoPoint`	The target location of the field of view.

Defined in

src/sdk/components/map/MapFieldOfViewCalculator.ts:9

MapLabeledRingLabelContent

Ƭ MapLabeledRingLabelContent: string | number | HTMLElement | DisplayComponent<any> | SVGElement

Valid content types for map ring labels.

Defined in

src/sdk/components/map/MapLabeledRingLabel.ts:7

MapMultiTransformedBinding

Ƭ MapMultiTransformedBinding<I, T>: Object

A binding from multiple sources to a target.

Type parameters

Name	Type
`I`	extends readonly `any`[]
`T`	`T`

Type declaration

Name	Type	Description
`map`	(`sources`: `Readonly`<`I`>) => `T`	A function which transforms source values, as a tuple, before they are applied to the target.
`sources`	`MappedSubscribableInputs`<`I`>	The sources of the binding.
`target`	`MutableSubscribable`<`any`, `T`>	The target of the binding.

Type declaration

Name	Type	Description
`projectedSize?`	`ReadonlyFloat64Array`	The size of the projected window, in pixels.
`range?`	`number`	The range of the projection, in great-arc radians. The range is measured between the projection's two range endpoints.
`rangeEndpoints?`	`ReadonlyFloat64Array`	The endpoints used to measure the range of the projection, as a 4-tuple `[relX1, relY1, relX2, relY2]`. Each component is expressed in relative projected coordinates, where `0` is the left/top of the projected window, and `1` is the right/bottom of the projected window.
`rotation?`	`number`	The post-projected rotation angle, in radians.
`target?`	`GeoPointInterface`	The target of the projection. The target is guaranteed to be projected to a specific point in the projected window defined by the center of the window plus the target projected offset.
`targetProjectedOffset?`	`ReadonlyFloat64Array`	The projected offset from the center of the projected window of the projection's target, in pixels.

Defined in

src/sdk/components/map/MapProjection.ts:10

MapSimpleBinding

Ƭ MapSimpleBinding<T>: Object

A binding from a source to a target.

Type parameters

Name
`T`

Type declaration

Name	Type	Description
`source`	`Subscribable`<`T`>	The source of the binding.
`target`	`MutableSubscribable`<`any`, `T`>	The target of the binding.

Defined in

src/sdk/components/mapsystem/controllers/MapBindingsController.ts:11

MapSystemContext

Ƭ MapSystemContext<Modules, Layers, Controllers, Context>: { bus: EventBus ; deadZone: Subscribable<ReadonlyFloat64Array> ; model: MapModel<Modules> ; projectedSize: Subscribable<ReadonlyFloat64Array> ; projection: MapProjection ; getController: <K>(key: K) => Controllers[K] ; getLayer: <K>(key: K) => Layers[K] } & Readonly<Context>

A context which holds data related to a compiled MapSystem map.

Type parameters

Name	Type
`Modules`	extends `ModuleRecord` = `EmptyRecord`
`Layers`	extends `LayerRecord` = `EmptyRecord`
`Controllers`	extends `ControllerRecord` = `EmptyRecord`
`Context`	extends `ContextRecord` = `EmptyRecord`

Defined in

src/sdk/components/mapsystem/MapSystemContext.ts:13

MapSystemCustomBuilder

Ƭ MapSystemCustomBuilder<Args, RequiredModules, RequiredLayers, RequiredContext>: (mapBuilder: MapSystemBuilder<RequiredModules, RequiredLayers, any, RequiredContext>, ...args: Args) => MapSystemBuilder<any, any, any, any>

A function which defines a custom build step.

Type parameters

Name	Type
`Args`	extends `any`[] = `any`[]
`RequiredModules`	extends `ModuleRecord` = `any`
`RequiredLayers`	extends `LayerRecord` = `any`
`RequiredContext`	extends `ContextRecord` = `any`

Type declaration

▸ (mapBuilder, ...args): MapSystemBuilder<any, any, any, any>

Parameters

Name	Type
`mapBuilder`	`MapSystemBuilder`<`RequiredModules`, `RequiredLayers`, `any`, `RequiredContext`>
`...args`	`Args`

Returns

MapSystemBuilder<any, any, any, any>

Defined in

src/sdk/components/mapsystem/MapSystemBuilder.tsx:64

MapSystemGenericControllerCallbacks

Ƭ MapSystemGenericControllerCallbacks<Context>: Object

Callbacks supported by MapSystemGenericController.

Type parameters

Name	Type
`Context`	extends `MapSystemContext`<`any`, `any`, `any`, `any`>

Type declaration

Name	Type
`onAfterMapRender?`	(`context`: `Context`) => `void`
`onAfterUpdated?`	(`context`: `Context`, `time`: `number`, `elapsed`: `number`) => `void`
`onBeforeUpdated?`	(`context`: `Context`, `time`: `number`, `elapsed`: `number`) => `void`
`onDeadZoneChanged?`	(`context`: `Context`, `deadZone`: `ReadonlyFloat64Array`) => `void`
`onDestroyed?`	(`context`: `Context`) => `void`
`onMapDestroyed?`	(`context`: `Context`) => `void`
`onMapProjectionChanged?`	(`context`: `Context`, `mapProjection`: `MapProjection`, `changeFlags`: `number`) => `void`
`onSleep?`	(`context`: `Context`) => `void`
`onWake?`	(`context`: `Context`) => `void`

Defined in

src/sdk/components/mapsystem/MapSystemGenericController.ts:10

MapTrafficIntruderIconFactory

Ƭ MapTrafficIntruderIconFactory<Modules, Layers, Controllers, Context>: (intruder: TcasIntruder, context: MapSystemContext<Modules, Layers, Controllers, Context>) => MapTrafficIntruderIcon

A function which creates map icons for TCAS intruders.

Type parameters

Name	Type
`Modules`	extends `ModuleRecord` = `any`
`Layers`	extends `LayerRecord` = `any`
`Controllers`	extends `ControllerRecord` = `any`
`Context`	extends `ContextRecord` = `any`

Type declaration

▸ (intruder, context): MapTrafficIntruderIcon

Parameters

Name	Type	Description
`intruder`	`TcasIntruder`	The intruder for which to create an icon.
`context`	`MapSystemContext`<`Modules`, `Layers`, `Controllers`, `Context`>	The context of the icon's parent map.

Returns

MapTrafficIntruderIcon

Defined in

src/sdk/components/mapsystem/layers/MapSystemTrafficLayer.tsx:51

MapTransformedBinding

Ƭ MapTransformedBinding<S, T>: Object

A binding from a transformed source to a target.

Type parameters

Name
`S`
`T`

Type declaration

Name	Type	Description
`map`	(`source`: `S`) => `T`	A function which transforms source values before they are applied to the target.
`source`	`Subscribable`<`S`>	The source of the binding.
`target`	`MutableSubscribable`<`any`, `T`>	The target of the binding.

Defined in

src/sdk/components/mapsystem/controllers/MapBindingsController.ts:22

MapWaypointRenderRoleDef

Ƭ MapWaypointRenderRoleDef<W>: Object

A render role definition.

Type parameters

Name	Type
`W`	extends `MapWaypoint`

Type declaration

Name	Type	Description
`canvasContext`	`CanvasRenderingContext2D` \| `null`	The canvas rendering context used to draw icons and labels for the render role.
`iconFactory`	`MapWaypointRendererIconFactory`<`W`> \| `null`	The icon factory used to create icons for the render role.
`labelFactory`	`MapWaypointRendererLabelFactory`<`W`> \| `null`	The label factory used to create labels for the render role.
`visibilityHandler`	(`waypoint`: `W`) => `boolean`	A function which determines whether a waypoint is visible under the render role.

Defined in

src/sdk/components/map/MapWaypointRenderer.ts:38

MapWaypointRenderRoleSelector

Ƭ MapWaypointRenderRoleSelector<W>: (entry: MapWaypointRendererEntry<W>, roleDefinitions: ReadonlyMap<number, Readonly<MapWaypointRenderRoleDef<W>>>) => number

A function which selects roles under which to render waypoints.

Type parameters

Name	Type
`W`	extends `MapWaypoint`

Type declaration

▸ (entry, roleDefinitions): number

Parameters

Name	Type
`entry`	`MapWaypointRendererEntry`<`W`>
`roleDefinitions`	`ReadonlyMap`<`number`, `Readonly`<`MapWaypointRenderRoleDef`<`W`>>>

src/sdk/geo/NavAngle.ts:10

NavComSimVars

Ƭ NavComSimVars: NavComEvents

Events related to nav, com, and ADF radios.

Defined in

src/sdk/instruments/NavCom.ts:290

NavMagneticVariation

Ƭ NavMagneticVariation: Object

The magnetic variation for a tuned nav station.

Type declaration

Name	Type	Description
`source`	`NavSourceId`	the nav source id
`variation`	`number`	the magnetic variation value

Defined in

src/sdk/instruments/NavProcessor.ts:328

NavRadioIndex

Ƭ NavRadioIndex: 1 | 2 | 3 | 4

Name	Type
`S`	extends `NearestSubscription`<`any`>

Defined in

A function which handles changes in an ObjectSubject's state.

Type parameters

Name	Type
`T`	extends `Record`<`string`, `any`>

Type declaration

▸ (v, key, newValue, oldValue): void

Parameters

Name	Type
`v`	`Readonly`<`T`>
`key`	keyof `T`
`newValue`	`T`[keyof `T`]
`oldValue`	`T`[keyof `T`]

This exposes all mutable subscribables defined in PerformancePlan, but allows "switching" the backing performance plan that the mutable subscribables reflect.

This is useful to tie CDU pages and CDU components to the relevant mutable subscribables without having to manually switch them around depending on MOD/ACT, for example.

Type parameters

Name	Type
`P`	extends `PerformancePlan`

Defined in

src/sdk/performance/PerformancePlanProxy.ts:22

PerformancePlanSyncEventsForId

Ƭ PerformancePlanSyncEventsForId<ID>: { [P in keyof BasePerformancePlanSyncEvents as `${P}${FlightPlannerEventSuffix<ID>}`]: BasePerformancePlanSyncEvents[P] }

Events published by a PerformancePlanRepository with a specific ID.

Type parameters

Name	Type
`ID`	extends `string`

Defined in

src/sdk/performance/PerformancePlanRepository.ts:34

PidOptions

Ƭ PidOptions: Object

Options for PidController.

Type declaration

Name	Type	Description
`kD`	`number`	kP
`kI`	`number`	kP
`kP`	`number`	kP
`maxI?`	`number`	maxI (optional)
`maxOut`	`number`	maxOut
`minI?`	`number`	minI (optional)
`minOut`	`number`	minOut

Type declaration

Name	Type	Description
`isOverpowerProtEngaged`	`boolean`	Whether overpower protection is engaged.
`isOverspeedProtEngaged`	`boolean`	Whether overspeed protection is engaged.
`isUnderspeedProtEngaged`	`boolean`	Whether underspeed protection is engaged.
`speed`	`number` \| `undefined`	The commanded throttle position adjustment speed.
`targetPos`	`number` \| `undefined`	The commanded throttle position.

Defined in

src/sdk/autothrottle/AbstractAutothrottle.ts:296

Radio

Ƭ Radio: Object

Encapsulates a single radio's state.

Type declaration

Name	Type	Description
`activeFrequency`	`number`	The current active frequency.
`ident`	`string` \| `null`	The ident of the active station
`index`	`number`	Index number of the radio.
`radioType`	`RadioType`	The appropriate RadioType for this radio.
`selected`	`boolean`	Whether this radio is selected for changes.
`signal`	`number`	Signal strength of the active station.
`standbyFrequency`	`number`	The current standby frequency.

Defined in

src/sdk/instruments/RadioCommon.ts:26

ReadonlyConsumerValue

Ƭ ReadonlyConsumerValue<T>: Pick<ConsumerValue<T>, "get" | "isAlive" | "isPaused">

A read-only ConsumerValue.

Type parameters

Name
`T`

Defined in

src/sdk/data/ConsumerValue.ts:8

ReadonlyFloat64Array

Ƭ ReadonlyFloat64Array: Readonly<Omit<Float64Array, "set" | "copyWithin" | "sort">>

A readonly version of a Float64Array.

Defined in

src/sdk/math/VecMath.ts:4

ReadonlySubEvent

Ƭ ReadonlySubEvent<SenderType, DataType>: Omit<SubEventInterface<SenderType, DataType>, "notify" | "clear">

An event to which handlers can be subscribed to be notified whenever the event is emitted.

Type parameters

Name
`SenderType`
`DataType`

Name	Type
`T`	`void`

Type declaration

Name	Type	Description
`onAcquired`	(`resource`: `T`) => `void`	A callback function which is called when this consumer gains access to its desired resource.
`onCeded`	(`resource`: `T`) => `void`	A callback function which is called when this consumer loses access to its desired resource.
`priority`	`number`	This consumer's priority for its desired resource. Consumers with higher priority will gain access to the resource over consumers with lower priority.

Defined in

src/sdk/utils/resource/ResourceModerator.ts:6

ScrollDirection

Ƭ ScrollDirection: "forward" | "backward"

A requested scroll direction.

Defined in

src/sdk/components/controls/HardwareUiControl.tsx:12

SearchTypeMap

Ƭ SearchTypeMap: Object

A type map of search type to facility type.

Type declaration

Name	Type	Description
`0`	`Facility`	All facilities.
`1`	`AirportFacility`	Airports.
`2`	`IntersectionFacility`	Intersections.
`3`	`VorFacility`	VORs.
`4`	`NdbFacility`	NDBs.
`5`	`BoundaryFacility`	Boundaries.
`6`	`UserFacility`	User facilities.
`7`	`VisualFacility`	Visual facilities.
`8`	`Facility`	All facilities except visual facilities.

Defined in

src/sdk/navigation/FacilityLoader.ts:67

SearchableFacilityTypes

Ƭ SearchableFacilityTypes: USR | VIS

src/sdk/flightplan/FlightPlanning.ts:322

SpeedConstraintDetails

Ƭ SpeedConstraintDetails: Object

The current speed constraint details including the currently applicable speed constraint (if any), the next speed constraint (if any) and the distance to the next speed constraint (if any).

Type declaration

Name	Type	Description
`currentSpeedConstraint`	`SpeedConstraint`	The currently applicable speed constraint.
`distanceToNextSpeedConstraint?`	`number`	The distance to the next speed constraint, in NM.
`nextSpeedConstraint`	`SpeedConstraint`	The next applicable speed constraint.

Defined in

src/sdk/autopilot/VerticalNavigation.ts:302

SubscribableArrayHandler

Ƭ SubscribableArrayHandler<T>: (index: number, type: SubscribableArrayEventType, item: T | readonly T[] | undefined, array: readonly T[]) => void

A function which handles changes in a SubscribableArray's state.

Type parameters

Name
`T`

Type declaration

▸ (index, type, item, array): void

Parameters

Name	Type
`index`	`number`
`type`	`SubscribableArrayEventType`
`item`	`T` \| readonly `T`[] \| `undefined`
`array`	readonly `T`[]

Returns

void

Defined in

src/sdk/sub/SubscribableArray.ts:20

SubscribableMapHandler

Ƭ SubscribableMapHandler<K, V>: (map: ReadonlyMap<K, V>, type: SubscribableMapEventType, key: K, value: V) => void

A function which handles changes in a SubscribableMap's state.

Type parameters

Name
`K`
`V`

Type declaration

▸ (map, type, key, value): void

Parameters

Name	Type
`map`	`ReadonlyMap`<`K`, `V`>
`type`	`SubscribableMapEventType`
`key`	`K`
`value`	`V`

Returns

void

Defined in

src/sdk/sub/SubscribableMap.ts:20

SubscribableSetHandler

Ƭ SubscribableSetHandler<T>: (set: ReadonlySet<T>, type: SubscribableSetEventType, key: T) => void

A function which handles changes in a SubscribableSet's state.

Type parameters

Name
`T`

Type declaration

▸ (set, type, key): void

Parameters

Name	Type
`set`	`ReadonlySet`<`T`>
`type`	`SubscribableSetEventType`
`key`	`T`

Returns

void

Defined in

src/sdk/sub/SubscribableSet.ts:17

SubscribableType

Ƭ SubscribableType<S>: S extends Subscribable<infer T> ? T : never

Utility type to retrieve the value type of a Subscribable.

Type parameters

Name
`S`

src/sdk/utils/task/TaskQueue.ts:2

TcasResolutionAdvisoryOptions

Ƭ TcasResolutionAdvisoryOptions: Object

Options to adjust how resolution advisories are calculated by TCAS.

Type declaration

Name	Type	Description
`allowClimb`	(`simTime`: `number`) => `boolean`	A function which determines whether to allow a CLIMB resolution advisory.
`allowDescend`	(`simTime`: `number`) => `boolean`	A function which determines whether to allow a DESCEND resolution advisory.
`allowIncreaseClimb`	(`simTime`: `number`) => `boolean`	A function which determines whether to allow an INCREASE CLIMB resolution advisory.
`allowIncreaseDescent`	(`simTime`: `number`) => `boolean`	A function which determines whether to allow an INCREASE DESCENT resolution advisory.
`initialAcceleration`	`NumberUnitInterface`<`Acceleration`>	The assumed acceleration of the own airplane following an initial resolution advisory.
`initialResponseTime`	`NumberUnitInterface`<`Duration`>	The assumed response time of the own airplane following an initial resolution advisory.
`subsequentAcceleration`	`NumberUnitInterface`<`Acceleration`>	The assumed acceleration of the own airplane following an updated resolution advisory.
`subsequentResponseTime`	`NumberUnitInterface`<`Duration`>	The assumed response time of the own airplane following an updated resolution advisory.

Defined in

src/sdk/traffic/Tcas.ts:415

TcasSensitivityParameters

Ƭ TcasSensitivityParameters: Object

A full set of TCAS sensitivity parameters.

Type declaration

Name	Type	Description
`parametersPA`	`TcasAdvisoryParameters`	Protected zone parameters for proximity advisories. If any parameters have a value of `NaN`, proximity advisories will not be issued.
`parametersRA`	`TcasTcaParameters`	Parameters for time-of-closest-approach calculations for resolution advisories. If any parameters have a value of `NaN`, resolution advisories will not be issued.
`parametersTA`	`TcasTcaParameters`	Parameters for time-of-closest-approach calculations for traffic advisories. If any parameters have a value of `NaN`, traffic advisories will not be issued.

Defined in

src/sdk/traffic/Tcas.ts:188

ToSubscribable

Ƭ ToSubscribable<S>: S extends Subscribable<infer T> ? Subscribable<T> : never

Utility type to convert a type of Subject into a Subscribable.

Type parameters

Name
`S`

Defined in

src/sdk/sub/Subscribable.ts:132

TrafficInstrumentOptions

Ƭ TrafficInstrumentOptions: Object

Initialization options for TrafficInstrument.

Type declaration

Name	Type	Description
`contactDeprecateTime`	`number`	The maximum amount of sim time elapsed, in milliseconds, since last contact allowed before a contact is deprecated.
`realTimeUpdateFreq`	`number`	The maximum update frequency (Hz) in real time.
`simTimeUpdateFreq`	`number`	The maximum update frequency (Hz) in sim time.

Defined in

src/sdk/instruments/Traffic.ts:65

TrafficOffScaleOobOptions

Ƭ TrafficOffScaleOobOptions: Object

Options for handling off-scale and out-of-bounds traffic intruders on a traffic layer.

Type declaration

Name	Type	Description
`offScaleIntruders?`	`MutableSubscribableSet`<`TcasIntruder`>	A subscribable set to update with off-scale intruders.
`oobIntruders?`	`MutableSubscribableSet`<`TcasIntruder`>	A subscribable set to update with intruders that are not off-scale but whose projected positions are considered out-of-bounds.
`oobOffset?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	A subscribable which provides the offset of the intruder out-of-bounds boundaries relative to the boundaries of the map's projected window, as `[left, top, right, bottom]` in pixels. Positive offsets are directed toward the center of the map. Defaults to `[0, 0, 0, 0]`.

Defined in

src/sdk/components/mapsystem/MapSystemBuilder.tsx:161

UiControlEventHandler

Ƭ UiControlEventHandler<T, Args>: (source: T, ...args: Args) => boolean

A handler for events emitted by UiControl2.

Type parameters

Name	Type	Description
`T`	extends `HardwareUiControl`<`any`, `any`>	The type of event sources.
`Args`	extends `any`[] = []	A tuple type describing additional arguments for an event after the source control. Defaults to an empty (zero-length) tuple.

Type declaration

▸ (source, ...args): boolean

Parameters

Name	Type
`source`	`T`
`...args`	`Args`

Type parameters

Name	Type
`T`	extends `UserSettingValue`

Type declaration

Name	Type	Description
`initSub`	`Subscription`	The initialization subscription for the setting.
`initUid`	`number`	The unique ID attached to this entry's setting's initialization sync event.
`setting`	`SyncableUserSetting`<`T`>	A user setting.
`syncTime`	`number`	The timestamp of the most recent sync event.
`syncTopic`	`usersetting_sync_${string}`	The event topic used to sync the setting.

Defined in

src/sdk/settings/UserSetting.ts:111

UserSettingManagerInitData

Ƭ UserSettingManagerInitData<T>: Object

Data provided for a setting sync event.

Type parameters

Name	Type
`T`	extends `UserSettingValue`

Type declaration

Name	Type	Description
`syncTime`	`number`	The timestamp of this initialization event.
`uid`	`number`	A unique ID attached to this initialization event.
`value`	`T`	The initialized value of the setting.

Defined in

src/sdk/settings/UserSetting.ts:131

UserSettingManagerSyncData

Ƭ UserSettingManagerSyncData<T>: Object

Data provided for a setting sync event.

Type parameters

Name	Type
`T`	extends `UserSettingValue`

Type declaration

Name	Type	Description
`initUid?`	`number`	The unique ID of the initialization event to which this sync event is responding. Only defined if this sync event is an initialization response.
`syncTime`	`number`	The timestamp of this sync event.
`value`	`T`	The synced value of the setting.

Defined in

src/sdk/settings/UserSetting.ts:145

UserSettingMap

Ƭ UserSettingMap<Aliased, Original>: { [Property in keyof Aliased]?: keyof Original }

An entry that maps one set of setting definitions to another.

Type parameters

Name
`Aliased`
`Original`

Type parameters

Name	Type
`T`	extends `UserSettingRecord`
`V`	`V`

Defined in

src/sdk/settings/UserSetting.ts:43

VectorStyleHandler

Ƭ VectorStyleHandler: (vector: CircleVector, isIngress: boolean, isEgress: boolean) => FlightPathRenderStyle

A handler that takes some vector data and returns the appropriate flight path rendering style.

Type declaration

▸ (vector, isIngress, isEgress): FlightPathRenderStyle

Parameters

Name	Type
`vector`	`CircleVector`
`isIngress`	`boolean`
`isEgress`	`boolean`

Returns

WildcardHandler

Ƭ WildcardHandler: (topic: string, data: any) => void

A handler for handling wildcard multiple subscription data.

Type declaration

▸ (topic, data): void

Parameters

Name	Type
`topic`	`string`
`data`	`any`

A type map of facility type to facility search type.

Type declaration

Name	Type	Description
`LOAD_AIRPORT`	`Airport`	Airport facility type.
`LOAD_INTERSECTION`	`Intersection`	Intersection facility type.
`LOAD_NDB`	`Ndb`	NDB facility type.
`LOAD_VOR`	`Vor`	VOR facility type.
`USR`	`User`	USR facility type.
`VIS`	`Visual`	Visual facility type.

Name	Type
`GetSimVarValue`	(`name`: `string`, `unit`: `string`, `dataSource?`: `string`) => `any`
`SetSimVarValue`	(`name`: `string`, `unit`: `string`, `value`: `any`, `dataSource?`: `string`) => `Promise`<`any`>

Defined in

src/sdk/data/SimVars.ts:151

Functions

Fragment

▸ Fragment(props): DisplayChildren[] | undefined

A fragment of existing elements with no specific root.

Parameters

Name	Type	Description
`props`	`ComponentProps`	The fragment properties.

Returns

DisplayChildren[] | undefined

The fragment children.

Defined in

src/sdk/components/FSComponent.ts:1493

registerPlugin

▸ registerPlugin<T>(plugin): void

Registers a plugin with the plugin system.

Type parameters

Name
`T`

Parameters

Name	Type	Description
`plugin`	(`binder`: `T`) => `AvionicsPlugin`<`T`>	The plugin to register.

Returns

void

Defined in

src/sdk/components/FSComponent.ts:1473

Namespaces
Enumerations
Classes
Interfaces
Type Aliases
Variables
Functions
- Fragment
- registerPlugin

Namespaces​

Enumerations​

Classes​

Interfaces​

Type Aliases​

APAltCapDirectorActivationFunc​

Type declaration​

Parameters​

Returns​

Defined in​

APAltCapDirectorCaptureFunc​

Type declaration​

Parameters​

Returns​

Defined in​

APAltCapDirectorOptions​

Type declaration​

Defined in​

APBackCourseDirectorInterceptFunc​

Type declaration​

Parameters​

Returns​

Defined in​

APBackCourseDirectorOptions​

Type declaration​

Defined in​

APBackCourseDirectorPhaseOptions​

Type declaration​

Defined in​

APBackCourseDirectorPhaseSelectorFunc​

Type declaration​

Parameters​

Returns​

Defined in​

APDirectors​

Type declaration​

Defined in​

APFLCDirectorOptions​

Type declaration​

Defined in​

APFLCDirectorSetSpeedCommand​

Type declaration​

Defined in​

APFPADirectorOptions​

Type declaration​

Defined in​

APGPDirectorGuidance​

Type declaration​

Defined in​

APGPDirectorOptions​

Type declaration​

Defined in​

APGSDirectorAngleClosureRateFunc​

Type declaration​

Parameters​

Returns​

Defined in​

APGSDirectorOptions​

Type declaration​

Defined in​

APGSDirectorVsTargetFunc​

Type declaration​

Parameters​

Returns​

Defined in​

APGpsSteerDirectorActivateState​

Type declaration​

Defined in​

APGpsSteerDirectorOptions​

Type declaration​

Defined in​

APGpsSteerDirectorSteerCommand​

Type declaration​

Defined in​

APHdgDirectorOptions​

Type declaration​

Defined in​

APHdgHoldDirectorOptions​

Type declaration​

Defined in​

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

APAltCapDirectorActivationFunc

Type declaration

Parameters

Returns

Defined in

APAltCapDirectorCaptureFunc

Type declaration

Parameters

Returns

Defined in

APAltCapDirectorOptions

Type declaration

Defined in

APBackCourseDirectorInterceptFunc

Type declaration

Parameters

Returns

Defined in

APBackCourseDirectorOptions

Type declaration

Defined in

APBackCourseDirectorPhaseOptions

Type declaration

Defined in

APBackCourseDirectorPhaseSelectorFunc

Type declaration

Parameters

Returns

Defined in

APDirectors

Type declaration

Defined in

APFLCDirectorOptions

Type declaration

Defined in

APFLCDirectorSetSpeedCommand

Type declaration

Defined in

APFPADirectorOptions

Type declaration

Defined in

APGPDirectorGuidance

Type declaration

Defined in

APGPDirectorOptions

Type declaration

Defined in

APGSDirectorAngleClosureRateFunc

Type declaration

Parameters

Returns

Defined in

APGSDirectorOptions

Type declaration

Defined in

APGSDirectorVsTargetFunc

Type declaration

Parameters

Returns

Defined in

APGpsSteerDirectorActivateState

Type declaration

Defined in

APGpsSteerDirectorOptions

Type declaration

Defined in

APGpsSteerDirectorSteerCommand

Type declaration

Defined in

APHdgDirectorOptions

Type declaration

Defined in

APHdgHoldDirectorOptions

Type declaration

Defined in