@microsoft/msfs-garminsdk

Enumerations

Classes

Interfaces

Type Aliases

APExternalGuidanceProviderOptions

Ƭ APExternalGuidanceProviderOptions: Object

Configuration options for APExternalGuidanceProvider.

Type declaration

Name	Type	Description
`supportGlidepath?`	`boolean`	Whether the provider supports glidepath guidance data. Defaults to `false`.
`supportGpsSteer?`	`boolean`	Whether the provider supports GPS steering command data. Defaults to `false`.
`supportVNav?`	`boolean`	Whether the provider supports VNAV guidance and VNAV path guidance data. Defaults to `false`.

Defined in

src/garminsdk/autopilot/data/APExternalGuidanceProvider.ts:12

ActiveFlightPlanOptions

Ƭ ActiveFlightPlanOptions: Object

Options for the display of the active flight plan.

Type declaration

Name	Type	Description
`lnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the LNAV from which to source data. Defaults to `0`.
`supportFocus?`	`boolean`	Whether to support flight plan focus on the primary flight plan. If focus is supported, the primary flight plan will be drawn when it is focused, regardless of whether it is active. Defaults to `false`.
`vnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the VNAV from which to source data. Defaults to `0`.

Defined in

src/garminsdk/components/map/GarminMapBuilder.tsx:102

AdcSystemSelectionState

Ƭ AdcSystemSelectionState: readonly [isAltitudeDataValid: boolean, isAirspeedDataValid: boolean, isTemperatureDataValid: boolean]

The state of an ADC used for selection.

Defined in

src/garminsdk/system/AdcSystemSelector.ts:11

AdcSystemSelectorOptions

Ƭ AdcSystemSelectorOptions: Object

Configuration options for AdcSystemSelector.

Type declaration

Name	Type	Description
`desirabilityComparator?`	(`a`: `AdcSystemSelectionState`, `b`: `AdcSystemSelectionState`) => `number`	A function that compares the desirability of two ADC systems.
`systemPriorities?`	readonly `number`[] \| `ReadonlyMap`<`number`, `number`> \| `SubscribableMap`<`number`, `number`>	The priorities for selecting individual ADC systems. If two systems have the same desirability, then the one with the higher priority will be selected. If a system's priority is not defined, then it will default to a value of `0`. The priorities can be specified as an array of ADC system indexes or a map of ADC system indexes to the priorities for selecting those systems. If specified as an array of indexes, then each system whose index appears in the array will be assigned a priority equal to `array.length - array.indexOf(index)`.

Defined in

src/garminsdk/system/AdcSystemSelector.ts:20

AhrsSystemSelectionState

Ƭ AhrsSystemSelectionState: readonly [isAttitudeDataValid: boolean, isHeadingDataValid: boolean]

The state of an AHRS used for selection.

Defined in

src/garminsdk/system/AhrsSystemSelector.ts:11

AhrsSystemSelectorOptions

Ƭ AhrsSystemSelectorOptions: Object

Configuration options for AhrsSystemSelector.

Type declaration

Name	Type	Description
`desirabilityComparator?`	(`a`: `AhrsSystemSelectionState`, `b`: `AhrsSystemSelectionState`) => `number`	A function that compares the desirability of two AHRS systems.
`systemPriorities?`	readonly `number`[] \| `ReadonlyMap`<`number`, `number`> \| `SubscribableMap`<`number`, `number`>	The priorities for selecting individual AHRS systems. If two systems have the same desirability, then the one with the higher priority will be selected. If a system's priority is not defined, then it will default to a value of `0`. The priorities can be specified as an array of AHRS system indexes or a map of AHRS system indexes to the priorities for selecting those systems. If specified as an array of indexes, then each system whose index appears in the array will be assigned a priority equal to `array.length - array.indexOf(index)`.

Defined in

src/garminsdk/system/AhrsSystemSelector.ts:19

AircraftSymbolOptions

Ƭ AircraftSymbolOptions: Pick<AttitudeAircraftSymbolProps, "color">

▸ (context): number | MappedSubscribable<number>

Parameters

Name	Type
`context`	`AirspeedDefinitionContext`

Type declaration

Name	Type	Description
`trendLookahead`	`number` \| `Subscribable`<`number`>	The lookahead time for the altitude trend, in seconds.

Type declaration

Name	Type	Description
`bestRnavType`	`RnavTypeFlags`	The best RNAV minima type available on the loaded approach.
`isCircling`	`boolean`	Whether the loaded approach is circling
`isLoaded`	`boolean`	Whether an approach is loaded.
`isRnpAr`	`boolean`	Whether the loaded approach is an RNAV RNP (AR) approach.
`isVtf`	`boolean`	Whether the loaded approach is a vectors-to-final approach.
`referenceFacility`	`VorFacility` \| `null`	The reference navaid facility for the loaded approach.
`rnavTypeFlags`	`RnavTypeFlags`	The RNAV minima types available on the loaded approach.
`runway`	`OneWayRunway` \| `null`	The runway associated with the loaded approach.
`type`	`GarminApproachType`	The type of the loaded approach.

Defined in

src/garminsdk/flightplan/FmsTypes.ts:55

ApproachListItem

Ƭ ApproachListItem: Object

An approach procedure paired with its index in its parent airport facility.

Type declaration

Name	Type	Description
`approach`	`ApproachProcedure`	The approach procedure.
`index`	`number`	The index of the approach in its parent airport facility.
`isVisualApproach`	`boolean`	Whether the approach is a visual approach.

Defined in

src/garminsdk/flightplan/FmsUtils.ts:1648

ApproachNameParts

Ƭ ApproachNameParts: Object

A type representing the three parts of an approach name.

Type declaration

Name	Type	Description
`flags?`	`string`	Additonal flags (eg, RNAV type)
`runway?`	`string`	The runway identifier.
`subtype?`	`string`	The approach subtype (eg, GPS)
`suffix?`	`string`	The approach suffix
`type`	`string`	The approach type.

Defined in

src/garminsdk/flightplan/FmsUtils.ts:1632

ArtificialHorizonColorStop

Ƭ ArtificialHorizonColorStop: [distance: number, color: string, step?: number]

A color gradient stop for ArtificialHorizon. The first member (distance) defines the distance of the stop from the horizon line, in pixels. The second member (color) defines the color of the stop. The optional third member (step) defines the distance, in pixels, between adjacent interpolated colors used to draw the gradient. The value of step must be at least 2 and defaults to 4.

Defined in

src/garminsdk/components/nextgenpfd/horizon/ArtificialHorizon.tsx:12

ArtificialHorizonSkyColor

Ƭ ArtificialHorizonSkyColor: ArtificialHorizonColorStop

A color gradient stop in the artificial horizon sky.

Deprecated

Defined in

src/garminsdk/components/nextgenpfd/horizon/ArtificialHorizon.tsx:18

AttitudeAircraftSymbolColor

Ƭ AttitudeAircraftSymbolColor: "yellow" | "white"

src/garminsdk/components/navdatafield/NavDataFieldTypeRenderers.tsx:67

CASAlertCounts

Ƭ CASAlertCounts: Object

A data structure for passing back info on the display status.

Type declaration

Name	Type	Description
`countAboveWindow`	`number`	The number of scrollable messages that are out of view above the selected window.
`countBelowWindow`	`number`	The number of scrollable messages that are out of view below the selected window.
`numAdvisory`	`number`	The number of advisories present.
`numCaution`	`number`	The number of cautions present.
`numSafeOp`	`number`	The number of safeop messages present.
`numWarning`	`number`	The number of warnings present.
`totalAlerts`	`number`	The total number of messages that are displayed.

Defined in

src/garminsdk/components/cas/CAS.tsx:8

ComRadioUserSettingTypes

Ƭ ComRadioUserSettingTypes: Object

COM radio user settings.

Type declaration

Name	Type	Description
`comRadioSpacing`	`ComRadioSpacingSettingMode`	COM radio channel spacing mode.

Defined in

src/garminsdk/settings/ComRadioUserSettings.ts:14

ConnextMapUserSettingTypes

Ƭ ConnextMapUserSettingTypes: Object

Connext weather map user settings.

Type declaration

Name	Type	Description
`connextMapRadarOverlayRangeIndex`	`number`	Connext radar overlay maximum range setting.
`connextMapRadarOverlayShow`	`boolean`	Whether the Connext weather map radar overlay is enabled.

Defined in

src/garminsdk/settings/WeatherMapUserSettings.ts:26

DateTimeUserSettingTypes

Ƭ DateTimeUserSettingTypes: Object

Garmin date/time user settings.

Type declaration

Name	Type	Description
`dateTimeFormat`	`DateTimeFormatSettingMode`	Date/time format.
`dateTimeLocalOffset`	`number`	Local time offset, in milliseconds.

Defined in

src/garminsdk/settings/DateTimeUserSettings.ts:15

DefaultNavDataBarFieldModelFactoryOptions

Ƭ DefaultNavDataBarFieldModelFactoryOptions: Object

Configuration options for DefaultNavDataBarFieldModelFactory.

Type declaration

Name	Type	Description
`lnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the LNAV from which to source data. Defaults to `0`.
`vnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the VNAV from which to source data. Defaults to `0`.

Defined in

src/garminsdk/components/navdatabar/DefaultNavDataBarFieldModelFactory.ts:19

DefaultObsSuspDataProviderOptions

Ƭ DefaultObsSuspDataProviderOptions: Object

Configuration options for DefaultObsSuspDataProvider.

Type declaration

Name	Type	Description
`lnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the LNAV from which to source data. Defaults to `0`.

Defined in

src/garminsdk/navigation/Obs.ts:34

DefaultTerrainSystemDataProviderOptions

Ƭ DefaultTerrainSystemDataProviderOptions: Object

Configuration options for DefaultTerrainSystemDataProvider.

Type declaration

Name	Type	Description
`adcIndex`	`number` \| `Subscribable`<`number`>	The index of the ADC from which to source data.
`ahrsIndex`	`number` \| `Subscribable`<`number`>	The index of the AHRS from which to source data.
`fmsPosIndex`	`number` \| `Subscribable`<`number`>	The index of the FMS geo-positioning system from which to source data.
`gpsAglSmootherParams?`	`Readonly`<`DefaultTerrainSystemDataProviderSmootherParams`>	Parameters for smoothing applied to GPS above ground height. `tau` defaults to `2000 / Math.LN2`, `tauVelocity` defaults to `1000 / Math.LN2`, and `tauAccel` defaults to `undefined.
`gpsVerticalSpeedSmootherParams?`	`Readonly`<`DefaultTerrainSystemDataProviderSmootherParams`>	Parameters for smoothing applied to GPS vertical speed. `tau` defaults to `1000 / Math.LN2`, `tauVelocity` and `tauAccel` default to `undefined.
`nearestAirportUpdateInterval?`	`number`	The interval at which the module's nearest airport data should be updated, in milliseconds. Defaults to 3000.
`radarAltIndex`	`number` \| `Subscribable`<`number`>	The index of the radar altimeter from which to source data.
`radarAltitudeSmootherParams?`	`Readonly`<`DefaultTerrainSystemDataProviderSmootherParams`>	Parameters for smoothing applied to radar altitude. `tau` defaults to `2000 / Math.LN2`, `tauVelocity` defaults to `1000 / Math.LN2`, and `tauAccel` defaults to `undefined.

Defined in

src/garminsdk/terrain/DefaultTerrainSystemDataProvider.ts:53

DefaultTerrainSystemDataProviderSmootherParams

Ƭ DefaultTerrainSystemDataProviderSmootherParams: Object

Parameters for exponential smoothers used by DefaultTerrainSystemDataProvider.

Type declaration

Name	Type	Description
`dtThreshold?`	`number`	The elapsed time threshold, in milliseconds, above which smoothing will not be applied to a new input value. Defaults to 10000.
`tau?`	`number`	The smoothing time constant, in milliseconds. The larger the constant, the greater the smoothing effect. A value less than or equal to 0 is equivalent to no smoothing.
`tauAccel?`	`number`	The time constant, in milliseconds, for smoothing the estimated acceleration of the input value. The larger the constant, the greater the smoothing effect applied to the estimated acceleration. A value less than or equal to 0 is equivalent to no smoothing. If this value or `tauVelocity` is not defined, then estimated acceleration will not be used to calculate the final smoothed value.
`tauVelocity?`	`number`	The time constant, in milliseconds, for smoothing the estimated velocity of the input value. The larger the constant, the greater the smoothing effect applied to the estimated velocity. A value less than or equal to 0 is equivalent to no smoothing. If not defined, then estimated velocity will not be used to calculate the final smoothed value.

Defined in

src/garminsdk/terrain/DefaultTerrainSystemDataProvider.ts:20

DefaultVNavDataProviderOptions

Ƭ DefaultVNavDataProviderOptions: Object

Configuration options for DefaultVNavDataProvider.

Type declaration

Name	Type	Description
`adcIndex?`	`number` \| `Subscribable`<`number`>	The index of the ADC from which to source data. Defaults to `1`.
`cdiId?`	`string` \| `Subscribable`<`string`>	The ID of the CDI from which to source data. Defaults to the empty string (`''`).
`vnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the VNAV from which to source data. Defaults to `0`.

Defined in

src/garminsdk/navigation/VNavDataProvider.ts:88

DefaultVSpeedAnnunciationDataProviderOptions

Ƭ DefaultVSpeedAnnunciationDataProviderOptions: Object

Configuration options for DefaultVSpeedAnnunciationDataProvider.

Type declaration

Name	Type	Description
`fmsId?`	`string` \| `Subscribable`<`string`>	The ID of the FMS from which to source flight phase data. Defaults to the empty ID (`''`).

Defined in

src/garminsdk/components/nextgenpfd/airspeed/VSpeedAnnunciationDataProvider.ts:31

DmeUserSettingTypes

Ƭ DmeUserSettingTypes: Object

Type descriptions for DME user settings.

Type declaration

Name	Type	Description
`dme1TuneMode`	`DmeTuneSettingMode`	Tuning mode for DME radio 1.
`dme2TuneMode`	`DmeTuneSettingMode`	Tuning mode for DME radio 2.

Type declaration

Name	Type	Description
`bankSmoothingTau?`	`number`	The time constant used to smooth flight director bank commands, in milliseconds.
`pitchSmoothingTau?`	`number`	The time constant used to smooth flight director pitch commands, in milliseconds.

Defined in

src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:44

FlightDirectorSingleCueOptions

Ƭ FlightDirectorSingleCueOptions: Pick<FlightDirectorSingleCueProps, "conformalBounds" | "conformalBankLimit">

Options for the single-cue flight director.

Defined in

src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:55

FlightPathCalculatorManagerOptions

Ƭ FlightPathCalculatorManagerOptions: Object

Configuration options for FlightPathCalculatorManager.

Type declaration

Name	Type	Description
`id?`	`string`	The ID of the flight path calculator to manage. Defaults to the empty string (`''`).
`isAdcDataValid?`	`Subscribable`<`boolean`>	Whether ADC data is valid, or `undefined` if flight path calculations do not use ADC data for calculating airplane speed.
`isGpsDataValid?`	`Subscribable`<`boolean`>	Whether GPS data is valid, or `undefined` if flight path calculations do not use GPS data for calculating airplane speed.
`lowBankAngle?`	`number`	The maximum bank angle, in degrees, supported in Low Bank Mode. Defaults to `maxBankAngle`.
`maxBankAngle`	`number`	The maximum bank angle, in degrees, supported outside of Low Bank Mode.

Type declaration

Name	Type	Description
`dataProvider`	`MapFlightPlanDataProvider`	The data provider for the flight plan to render.
`drawEntirePlan?`	`boolean` \| `Subscribable`<`boolean`>	Whether to always draw the entire plan, or a subscribable which provides it. Defaults to `false`.
`pathRenderer`	`MapFlightPathPlanRenderer`	The flight path renderer to use.

Defined in

src/garminsdk/components/map/GarminMapBuilder.tsx:88

FmaData

Ƭ FmaData: Object

Data describing autopilot status used by Garmin FMAs.

Type declaration

Name	Type	Description
`altitideCaptureArmed`	`boolean`	Whether an altitude capture mode is armed.
`altitideCaptureValue`	`number`	The target altitude capture value, in feet.
`lateralActive`	`APLateralModes`	The active lateral mode.
`lateralArmed`	`APLateralModes`	The armed lateral mode.
`lateralModeFailed`	`boolean`	Whether the lateral mode is in a failed state.
`verticalActive`	`APVerticalModes`	The active vertical mode.
`verticalAltitudeArmed`	`APAltitudeModes`	The armed altitude capture mode.
`verticalApproachArmed`	`APVerticalModes`	The armed vertical approach mode.
`verticalArmed`	`APVerticalModes`	The armed vertical mode.
`vnavState`	`FmaVNavState`	The state of VNAV to be displayed on the FMA.

Defined in

src/garminsdk/autopilot/FmaData.ts:6

FmaModeSlotActiveData

Ƭ FmaModeSlotActiveData: Object

Data describing the active autopilot mode for an FMA mode display slot.

Type declaration

Name	Type	Description
`active`	`string`	The active mode.
`armedTransition`	`string` \| `undefined`	The armed mode from which the active mode transitioned.
`failed`	`string` \| `undefined`	The failed mode that caused the transition to the current active mode.
`secondaryArmedTransition`	`string` \| `undefined`	The secondary armed mode from which the active mode transitioned.

Defined in

src/garminsdk/components/nextgenpfd/fma/FmaModeSlot.tsx:6

FmsEventsForId

Ƭ FmsEventsForId<ID>: { [P in keyof BaseFmsEvents as `${P}${FmsEventSuffix<ID>}`]: BaseFmsEvents[P] }

Events published by an Fms with a specific ID.

Type parameters

Name	Type
`ID`	extends `string`

Defined in

src/garminsdk/flightplan/FmsEvents.ts:28

FmsFlightPhase

Ƭ FmsFlightPhase: Object

Details on the current FMS phase of flight.

Type declaration

Name	Type	Description
`isApproachActive`	`boolean`	Whether the approach is active.
`isInMissedApproach`	`boolean`	Whether the missed approach is active.
`isPastFaf`	`boolean`	Whether the active leg is past the final approach fix.
`isToFaf`	`boolean`	Whether the active leg is the leg to the final approach fix.

Defined in

src/garminsdk/flightplan/FmsTypes.ts:87

FmsFplUserDataTypeMap

Ƭ FmsFplUserDataTypeMap: Object

Mappings from Garmin flight plan user data keys to their data types.

Type declaration

Name	Type	Description
`name`	`string`	The name of the flight plan.
`skipCourseReversal`	`boolean`	Whether the flight plan's loaded approach procedure skips an initial course reversal.
`vfr_approach_data`	`Readonly`<`FmsFplVfrApproachData`>	Data describing the flight plan's loaded VFR approach procedure.
`visual_approach`	`string`	The designation of the runway associated with the flight plan's loaded visual approach procedure.
`visual_approach_data`	`Readonly`<`FmsFplVisualApproachData`>	Data describing the flight plan's loaded visual approach procedure.

Defined in

src/garminsdk/flightplan/FmsFplUserDataTypes.ts:49

FmsFplVfrApproachData

Ƭ FmsFplVfrApproachData: Object

Data describing a VFR approach procedure that is loaded into a flight plan.

Type declaration

Name	Type	Description
`approachIndex`	`number`	The index of the published approach procedure on which the loaded VFR approach is based.
`isVtf`	`boolean`	Whether the loaded approach is a vectors-to-final (VTF) approach.

Defined in

src/garminsdk/flightplan/FmsFplUserDataTypes.ts:38

FmsFplVisualApproachData

Ƭ FmsFplVisualApproachData: Object

Data describing a visual approach procedure that is loaded into a flight plan.

Type declaration

Name	Type	Description
`isVtf`	`boolean`	Whether the loaded approach is a vectors-to-final (VTF) approach.
`runwayDesignation`	`string`	The designation of the runway associated with the loaded visual approach procedure.

Defined in

src/garminsdk/flightplan/FmsFplUserDataTypes.ts:27

FmsOptions

Ƭ FmsOptions: Object

Configuration options for Fms.

Type declaration

Name	Type	Description
`cdiId?`	`string`	The ID of the CDI associated with the FMS. Defaults to the empty string (`''`).
`disableApproachAvailablePublish?`	`boolean`	Whether to prevent the FMS from publishing the FMS flight phase approach active status to the `approach_available` event bus topic. Defaults to `false`.
`isAdvancedVnav?`	`boolean`	Whether advanced VNAV is supported. Defaults to `false`.
`lnavIndex?`	`number`	The index of the LNAV associated with the FMS's active flight plan. Defaults to `0`.
`navRadioIndexes?`	`Iterable`<`NavRadioIndex`>	The indexes of the sim NAV radios for which the FMS automatically tunes approach frequencies. The FMS will respect changes made to the iterable after the FMS is created. Defaults to `[1, 2]`.
`procedureLegMapper?`	(`leg`: `FlightPlanLeg`) => `undefined` \| `FlightPlanLeg`	A function that maps flight plan legs in a procedure to flight plan legs to insert into a flight plan when loading the procedure. If the function returns `undefined`, then the corresponding procedure leg will be omitted from the flight plan entirely. If not defined, then all procedure flight plan legs are inserted into the flight plan without modification.
`useSimObsState?`	`boolean`	Whether to use the sim's native OBS state. If `true`, then the sim's OBS state as exposed through the event bus topics defined in `NavEvents` will be used, and standard sim OBS key events will be used to control the state. If `false`, then the OBS state exposed through the event bus topics defined in `LNavObsEvents` will be used, and control events defined in `LNavObsControlEvents` will be used to control the state. Defaults to `true`.
`visualApproachOptions?`	`Readonly`<`FmsVisualApproachOptions`>	Options for visual approach procedures. If not defined, then visual approach fix distances will default to 2.5 nautical miles for both runway to FINAL and FINAL to STRGHT.
`vnavIndex?`	`number`	The index of the VNAV associated with the FMS's flight plans. Defaults to `0`. If a vertical path calculator is not provided to the FMS, then this option will be ignored.

Defined in

src/garminsdk/flightplan/Fms.ts:40

FmsVisualApproachOptions

Ƭ FmsVisualApproachOptions: Object

Options for visual approach procedures.

Type declaration

Name	Type	Description
`finalFixDistance`	`number`	The distance from the FINAL fix to the runway fix, in nautical miles.
`strghtFixDistance`	`number`	The distance from the STRGHT fix to the FINAL fix, in nautical miles.

Defined in

src/garminsdk/flightplan/Fms.ts:29

GarminAPConfigDirectorOptions

Ƭ GarminAPConfigDirectorOptions: Object

Options for configuring Garmin autopilot directors.

Type declaration

Name	Type	Description
`cdiId?`	`string`	The ID of the CDI associated with the autopilot. Defaults to the empty string (`''`).
`defaultBankRate?`	`number`	The default rate at which commanded bank changes, in degrees per second. Defaults to `10`.
`defaultPitchRate?`	`number`	The default rate at which commanded pitch changes, in degrees per second. Defaults to `5`.
`glidepathGuidance?`	`Accessible`<`Readonly`<`GarminVNavGlidepathGuidance`>>	Guidance for the autopilot's glidepath director to use. Ignored if `useInternalVNavComputer` is `true`.
`hdgMaxBankAngle?`	`number`	The maximum bank angle, in degrees, supported by the HDG director. Defaults to `25`.
`hdgTurnReversalThreshold?`	`number`	The threshold difference between selected heading and current heading, in degrees, at which the heading director unlocks its commanded turn direction and chooses a new optimal turn direction to establish on the selected heading, potentially resulting in a turn reversal. Any value less than or equal to 180 degrees effectively prevents the director from locking a commanded turn direction. Any value greater than or equal to 360 degrees will require the selected heading to traverse past the current heading in the desired turn direction in order for the director to issue a turn reversal. Defaults to `331`.
`lnavMaxBankAngle?`	`number`	The maximum bank angle, in degrees, supported by the LNAV director. Defaults to `25`.
`lnavOptions?`	`Readonly`<`GarminLNavDirectorOptions`>	Options for the LNAV director.
`locMaxBankAngle?`	`number`	The maximum bank angle, in degrees, supported by the LOC director. Defaults to `25`.
`lowBankAngle?`	`number`	The maximum bank angle, in degrees, to apply to the HDG, VOR, LOC, and LNAV directors while in Low Bank Mode. Defaults to `15`.
`rollMaxBankAngle?`	`number`	The maximum bank angle, in degrees, supported by the ROL director. Defaults to `25`.
`rollMinBankAngle?`	`number`	The minimum bank angle, in degrees, supported by the ROL director. Defaults to `6`.
`useInternalVNavComputer?`	`boolean`	Whether the autopilot should use internal VNAV and glidepath computers. Internal computers require that a vertical path calculator and either flight planner or static (not subscribable) FMS instance be defined. If these conditions are not met and `useInternalVNavComputer` is `true`, then the autopilot will be configured without VNAV or glidepath capability. Defaults to `true`.
`verticalPathGuidance?`	`Accessible`<`Readonly`<`GarminVNavPathGuidance`>>	Guidance for the autopilot's VNAV path director to use. Ignored if `useInternalVNavComputer` is `true`.
`vnavGuidance?`	`Accessible`<`Readonly`<`GarminVNavGuidance`>>	VNAV guidance for the autopilot's VNAV manager to use. Ignored if `useInternalVNavComputer` is `true`.
`vnavOptions?`	`Readonly`<`GarminVNavManager2InternalComputerOptions`>	Options for the autopilot's internal VNAV and glidepath computers. Ignored if `useInternalVNavComputer` is `false`.
`vorMaxBankAngle?`	`number`	The maximum bank angle, in degrees, supported by the VOR director. Defaults to `25`.

Type declaration

Name	Type	Description
`altSelectOptions?`	`Readonly`<`Partial`<`AltitudeSelectManagerOptions`>>	Options for the autopilot's altitude select manager. The following default options will be applied if they are not explicitly provided: `supportMetric: true, minValue: UnitType.FOOT.createNumber(-1000), maxValue: UnitType.FOOT.createNumber(50000), inputIncrLargeThreshold: 999, incrSmall: UnitType.FOOT.createNumber(100), incrLarge: UnitType.FOOT.createNumber(1000), incrSmallMetric: UnitType.METER.createNumber(50), incrLargeMetric: UnitType.METER.createNumber(500), initOnInput: true, initToIndicatedAlt: true, transformSetToIncDec: false`
`metricAltSettingsManager?`	`MetricAltitudeSettingsManager`	A manager of metric altitude mode user settings. Required for the autopilot's altitude select manager to support metric mode.
`minimumsDataProvider?`	`MinimumsDataProvider`	A provider of minimums data. If defined, the autopilot's altitude select manager will add an additional selected altitude stop at the baro minimums altitude if one is set.
`supportMachSelect?`	`boolean`	Whether to support mach number as the selected airspeed reference. Defaults to `false`.

Defined in

src/garminsdk/autopilot/GarminAutopilot.ts:16

GarminExcessiveClosureRateAlert

Ƭ GarminExcessiveClosureRateAlert: EcrWarning | EcrCaution

src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateTypes.ts:6

GarminNegativeClimbRateModuleOptions

Ƭ GarminNegativeClimbRateModuleOptions: Object

Configuration options for GarminNegativeClimbRateModule.

Type declaration

Name	Type	Description
`functionAsGpws?`	`boolean`	Whether alerting should function as a GPWS alert. If `true`, then radar altimeter data (up to 2500 feet AGL) will be used to measure height above terrain, and alerting will be inhibited when the `GarminTawsStatus.GpwsFailed` status is active. If `false`, then GPS altitude in conjunction with runway threshold elevation data will be used to measure height above terrain, and alerting will be inhibited when the `GarminTawsStatus.TawsFailed` or `GarminTawsStatus.TawsNotAvailable` statuses are active. Defaults to `false`.
`inhibitFlags?`	`Iterable`<`string`>	The inhibit flags that should inhibit alerting. If not defined, then no flags will inhibit alerting.

Defined in

src/garminsdk/terrain/modules/ncr/GarminNegativeClimbRateModule.ts:10

GarminObsDirectorOptions

Ƭ GarminObsDirectorOptions: Object

Options for GarminObsDirector.

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`.
`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`).

Defined in

src/garminsdk/autopilot/directors/GarminObsDirector.ts:10

GarminObsLNavModuleOptions

Ƭ GarminObsLNavModuleOptions: Object

Options for GarminObsLNavModule.

Type declaration

Name	Type	Description
`intercept?`	`LNavInterceptFunc`	A function used to translate DTK and XTK into a track intercept angle. If not defined, then a function that computes intercept angles tuned for slow GA aircraft will be used.
`maxBankAngle?`	`number` \| () => `number`	The maximum bank angle, in degrees, supported by the module, or a function which returns it. If not defined, then the module will use the value published to the event bus for the autopilot's maximum bank angle. Defaults to `undefined`.
`useSimObsState?`	`boolean`	Whether to use the sim's native OBS state. If `true`, then the sim's OBS state as exposed through the event bus topics defined in `NavEvents` will be used, and standard sim OBS key events will be used to control the state. If `false`, then the OBS state exposed through the event bus topics defined in `LNavObsEvents` will be used, and control events defined in `LNavObsControlEvents` will be used to control the state. Defaults to `true`.

Defined in

src/garminsdk/autopilot/lnav/GarminObsLNavModule.ts:11

GarminPrematureDescentAlert

Ƭ GarminPrematureDescentAlert: PdaCaution

Type parameters

Name	Type
`ID`	extends `string`

Defined in

src/garminsdk/timer/GarminTimerControlEvents.ts:34

GarminTimerManagerOptions

Ƭ GarminTimerManagerOptions: Object

Configuration options for GarminTimerManager.

Type declaration

Name	Type	Description
`genericTimerCount`	`number`	The number of supported generic timers.
`id?`	`string`	The ID of the managed timers. Defaults to the empty ID (`''`).

Defined in

src/garminsdk/timer/GarminTimerManager.ts:11

GarminVNavComputerAPValues

Ƭ GarminVNavComputerAPValues: Object

Autopilot values used by a Garmin VNAV computer.

Type declaration

Name	Type	Description
`lateralActive`	`Accessible`<`APLateralModes`>	The active lateral mode.
`selectedAltitude`	`Accessible`<`number`>	The selected reference altitude, in feet.
`selectedVerticalSpeed`	`Accessible`<`number`>	The selected reference vertical speed, in feet per minute.
`verticalActive`	`Accessible`<`APVerticalModes`>	The active vertical mode.
`verticalArmed`	`Accessible`<`APVerticalModes`>	The armed vertical mode.

Defined in

src/garminsdk/autopilot/vnav/GarminVNavTypes.ts:57

GarminVNavGlidepathGuidance

Ƭ GarminVNavGlidepathGuidance: Object

Glidepath guidance issued by Garmin VNAV.

Type declaration

Name	Type	Description
`approachHasGlidepath`	`boolean`	Whether the currently loaded approach has glidepath guidance.
`canCapture`	`boolean`	Whether the glidepath can be captured from an armed state.
`deviation`	`number`	The deviation of the glidepath from the airplane, in feet. Positive values indicate the path lies above the airplane.
`fpa`	`number`	The flight path angle of the glidepath, in degrees. Positive angles indicate a downward-sloping path.
`isValid`	`boolean`	Whether this guidance is valid.

Defined in

src/garminsdk/autopilot/vnav/GarminVNavTypes.ts:126

GarminVNavGuidance

Ƭ GarminVNavGuidance: Object

An object describing Garmin VNAV guidance.

Type declaration

Name	Type	Description
`altitudeCaptureType`	`VNavAltCaptureType`	The current VNAV altitude capture type.
`altitudeToCapture`	`number`	The altitude to capture, in feet.
`armedClimbMode`	`APVerticalModes`	The climb mode to arm.
`isActive`	`boolean`	Whether VNAV guidance is active.
`pathMode`	`VNavPathMode`	The current VNAV path mode.
`shouldActivateClimbMode`	`boolean`	Whether the armed climb mode should be activated.
`shouldCaptureAltitude`	`boolean`	Whether an altitude should be captured.
`state`	`VNavState`	The state of VNAV.

Defined in

src/garminsdk/autopilot/vnav/GarminVNavTypes.ts:77

GarminVNavPathGuidance

Ƭ GarminVNavPathGuidance: Object

Vertical path guidance issued by Garmin VNAV.

Type declaration

Name	Type	Description
`deviation`	`number`	The deviation of the vertical track from the airplane, in feet. Positive values indicate the track lies above the airplane.
`fpa`	`number`	The flight path angle of the vertical track, in degrees. Positive angles indicate a downward-sloping track.
`isValid`	`boolean`	Whether this guidance is valid.

Type declaration

Name	Type	Description
`inhibit500WhenGsGpActive?`	`boolean`	Whether to inhibit the 500-feet callout when the autopilot's GS or GP mode is active. Defaults to `false`.
`nearestRunwayUpdateInterval?`	`number`	The interval at which the module's nearest runway data should be updated, in milliseconds. Defaults to 3000.

Defined in

src/garminsdk/terrain/modules/voicecallout/GarminVoiceCalloutModule.ts:11

GpsNavSourceOptions

Ƭ GpsNavSourceOptions: Object

Configuration options for GpsNavSource.

Type declaration

Name	Type	Description
`lnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the LNAV from which to source data. Defaults to `0`.
`vnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the VNAV from which to source data. Defaults to `0`.

Defined in

src/garminsdk/navreference/source/GpsNavSource.ts:15

GpsReceiverSelectionState

Ƭ GpsReceiverSelectionState: readonly [systemState: GPSSystemState, pdop: number, hdop: number, vdop: number]

src/garminsdk/components/map/GarminMapBuilder.tsx:145

LNavDataDtkVector

Ƭ LNavDataDtkVector: Object

Information on a vector associated with a nominal LNAV desired track.

Type declaration

Name	Type	Description
`globalLegIndex`	`number`	The global index of the flight plan leg to which the vector belongs, or `-1` if there is no vector.
`vectorIndex`	`number`	The index of the vector in its parent leg's `flightPath` array, or `-1` if there is no vector.

src/garminsdk/components/map/controllers/MapAirspaceVisController.ts:12

MapFlightPlanFocusRangeTarget

Ƭ MapFlightPlanFocusRangeTarget: MapFieldOfView

Deprecated

Defined in

src/garminsdk/components/map/controllers/MapOrientationController.ts:40

MapOrientationSettingsControllerSettings

Ƭ MapOrientationSettingsControllerSettings: Pick<MapUserSettingTypes, "mapOrientation" | "mapAutoNorthUpActive" | "mapAutoNorthUpRangeIndex" | "mapGroundNorthUpActive">

User settings required by MapOrientationSettingsController.

Defined in

src/garminsdk/components/map/controllers/MapOrientationSettingsController.ts:20

MapPointerRTRControllerContext

Ƭ MapPointerRTRControllerContext: Record<string, never>

Context properties required for MapPointerRTRController.

Defined in

src/garminsdk/components/map/controllers/MapPointerRTRController.ts:29

MapRangeCompassLabelRenderer

Ƭ MapRangeCompassLabelRenderer: (range: Subscribable<NumberUnitInterface<UnitFamily.Distance>>, displayUnit: Subscribable<Unit<UnitFamily.Distance>>) => VNode

A function which renders labels for map range compasses.

Type declaration

▸ (range, displayUnit): VNode

Parameters

Name	Type
`range`	`Subscribable`<`NumberUnitInterface`<`UnitFamily.Distance`>>
`displayUnit`	`Subscribable`<`Unit`<`UnitFamily.Distance`>>

Returns

VNode

Defined in

src/garminsdk/components/map/layers/MapRangeCompassLayer.tsx:44

MapRangeControllerSettings

Ƭ MapRangeControllerSettings: Object

User settings required by MapRangeController.

Type declaration

Name	Type	Description
`mapRangeIndex?`	`number`	The range setting.

Defined in

src/garminsdk/components/map/controllers/MapRangeController.ts:24

MapRangeRingLabelRenderer

Ƭ MapRangeRingLabelRenderer: (range: Subscribable<NumberUnitInterface<UnitFamily.Distance>>, displayUnit: Subscribable<Unit<UnitFamily.Distance>>) => VNode

A function which renders labels for map range rings.

Type declaration

▸ (range, displayUnit): VNode

Parameters

Name	Type
`range`	`Subscribable`<`NumberUnitInterface`<`UnitFamily.Distance`>>
`displayUnit`	`Subscribable`<`Unit`<`UnitFamily.Distance`>>

Returns

VNode

Defined in

src/garminsdk/components/map/layers/MapRangeRingLayer.tsx:28

MapRangeValueDisplayProps

Ƭ MapRangeValueDisplayProps: MapRangeValueDisplayRangeProps & ComponentProps & { class?: string | SubscribableSet<string> ; displayUnit: Subscribable<Unit<UnitFamily.Distance> | null> }

src/garminsdk/components/map/controllers/MapTerrainController.ts:13

MapTerrainWxUserSettings

Ƭ MapTerrainWxUserSettings: Pick<MapUserSettingTypes, "mapTerrainMode" | "mapNexradShow">

User settings controlling the display of map terrain and weather overlays.

Defined in

src/garminsdk/components/map/MapTerrainWxSettingCompatManager.ts:8

MapTrafficIntruderIconOptions

Ƭ MapTrafficIntruderIconOptions: Object

Configuration options for MapTrafficIntruderIcon.

Type declaration

Name	Type	Description
`drawOffScale`	`boolean`	Whether to draw the icon if the intruder is off-scale.
`drawTARAVectorAsNormalVector?`	`boolean`	Whether or not to force TA and RA vectors to be drawn as normal motion vectors.
`fontSize`	`number`	The size of the icon font, in pixels.
`forceDrawNoArrow?`	`boolean`	Whether or not to force drawing of the non-arrow icons.
`iconSize`	`number`	The size of the icon, in pixels.
`supportAdsbVector`	`boolean`	Whether to support the display of ADS-B motion vectors.
`vectorLength?`	`number`	Forces the motion vector length to a set pixel length.

Defined in

src/garminsdk/components/map/MapTrafficIntruderIcon.tsx:14

MapTrafficUserSettings

Ƭ MapTrafficUserSettings: Pick<MapUserSettingTypes, "mapTrafficShow" | "mapTrafficRangeIndex" | "mapTrafficAlertLevelMode" | "mapTrafficLabelShow" | "mapTrafficLabelRangeIndex">

src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:42

MapWaypointIconStyles

Ƭ MapWaypointIconStyles: Object

Map waypoint icon styles.

Type declaration

Name	Type	Description
`priority`	`number` \| `Subscribable`<`number`>	The render priority of the icon. Icons with higher priority will be rendered on top of icons with lower priority.
`size`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The size of the icon, as `[width, height]` in pixels.

Defined in

src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:20

MapWaypointLabelStyles

Ƭ MapWaypointLabelStyles: Object

Map waypoint label styles.

Type declaration

Name	Type	Description
`alwaysShow`	`boolean` \| `Subscribable`<`boolean`>	Whether the label is immune to culling.
`options?`	`MapLocationTextLabelOptions`	Style options for the label.
`priority`	`number` \| `Subscribable`<`number`>	The render priority of the label. Labels with higher priority will be rendered on top of labels with lower priority. Moreover, labels with lower priority will be preferentially culled over labels with higher priority.

Defined in

src/garminsdk/components/map/MapWaypointDisplayBuilder.ts:50

MapWaypointVisUserSettings

User settings controlling the visibility of map waypoints.

Defined in

src/garminsdk/components/map/controllers/MapWaypointsVisController.ts:13

MapWaypointsVisControllerOptions

Ƭ MapWaypointsVisControllerOptions: Object

Configuration options for MapWaypointsVisController.

Type declaration

Name	Type	Description
`airportLargeMaxDeclutterMode?`	`MapDeclutterMode`	The highest global declutter mode, inclusive, at which large airports should remain visible. Defaults to MapDeclutterMode.Level2.
`airportMediumMaxDeclutterMode?`	`MapDeclutterMode`	The highest global declutter mode, inclusive, at which medium airports should remain visible. Defaults to MapDeclutterMode.Level2.
`airportSmallMaxDeclutterMode?`	`MapDeclutterMode`	The highest global declutter mode, inclusive, at which small airports should remain visible. Defaults to MapDeclutterMode.Level2.
`intMaxDeclutterMode?`	`MapDeclutterMode`	The highest global declutter mode, inclusive, at which intersections should remain visible. Defaults to MapDeclutterMode.Level3.
`ndbMaxDeclutterMode?`	`MapDeclutterMode`	The highest global declutter mode, inclusive, at which NDBs should remain visible. Defaults to MapDeclutterMode.Level3.
`userMaxDeclutterMode?`	`MapDeclutterMode`	The highest global declutter mode, inclusive, at which user waypoints should remain visible. Defaults to MapDeclutterMode.Level3.
`vorMaxDeclutterMode?`	`MapDeclutterMode`	The highest global declutter mode, inclusive, at which VORs should remain visible. Defaults to MapDeclutterMode.Level3.

Type parameters

Name
`V`

Type declaration

Name	Type	Description
`index`	`number`	The index of the softkey.
`label`	`string`	The label of the softkey.
`value`	`V`	The setting value bound to the softkey.

Type parameters

Name	Type
`T`	extends `NumberUnitInterface`<`NavAngleUnitFamily`, `NavAngleUnit`>

Defined in

src/garminsdk/components/navdatafield/NavDataFieldTypeRenderers.tsx:74

NavDataFieldDurationRendererOptions

Ƭ NavDataFieldDurationRendererOptions<T>: Pick<NavDataDurationFieldProps<T>, "options"> & BaseNavDataFieldTypeRendererOptions

Configuration options for NavDataFieldDurationRenderer.

Type parameters

Name	Type
`T`	extends `NumberUnitInterface`<`UnitFamily.Duration`>

Defined in

src/garminsdk/components/navdatafield/NavDataFieldTypeRenderers.tsx:119

NavDataFieldNumberUnitRendererOptions

Ƭ NavDataFieldNumberUnitRendererOptions<T>: Pick<NavDataNumberUnitFieldProps<T>, "displayUnit" | "formatter" | "unitFormatter" | "hideUnitWhenNaN"> & BaseNavDataFieldTypeRendererOptions

Configuration options for NavDataFieldNumberUnitRenderer.

Type parameters

Name	Type
`T`	extends `NumberUnitInterface`<`string`>

Defined in

src/garminsdk/components/navdatafield/NavDataFieldTypeRenderers.tsx:29

NavDataFieldTextRendererOptions

Ƭ NavDataFieldTextRendererOptions<T>: { formatter?: (value: T) => string } & BaseNavDataFieldTypeRendererOptions

Configuration options for NavDataFieldTextRenderer.

Type parameters

Name
`T`

Defined in

src/garminsdk/components/navdatafield/NavDataFieldTypeRenderers.tsx:198

NavDataFieldTimeRendererOptions

Ƭ NavDataFieldTimeRendererOptions: Pick<NavDataTimeFieldProps, "format" | "localOffset" | "padHour" | "suffixFormatter" | "hideSuffixWhenNaN"> & BaseNavDataFieldTypeRendererOptions

Configuration options for NavDataFieldTimeRenderer.

Defined in

src/garminsdk/components/navdatafield/NavDataFieldTypeRenderers.tsx:160

NavDataFieldTypeModelMap

Ƭ NavDataFieldTypeModelMap: Object

A map from navigation data field type to data model type.

Type declaration

Name	Type	Description
`AGL`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Distance`>>	Altitude above ground level.
`BRG`	`NavDataFieldModel`<`NumberUnitInterface`<`NavAngleUnitFamily`, `NavAngleUnit`>>	Bearing to next waypoint.
`CAB`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Distance`>>	Cabin altitude.
`CLG`	`NavDataFieldModel`<`number`>	Climb gradient.
`CLM`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.DistanceRatio`>>	Climb gradient (height per distance).
`CO`	`NavDataFieldModel`<`number`>	Carbon monoxide sensor value.
`DA`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Distance`>>	Density altitude.
`DEST`	`NavDataFieldModel`<`string`>	Destination ident.
`DIS`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Distance`>>	Distance to next waypoint.
`DTG`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Distance`>>	Distance to destination.
`DTK`	`NavDataFieldModel`<`NumberUnitInterface`<`NavAngleUnitFamily`, `NavAngleUnit`>>	Desired track.
`ECO`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.DistancePerWeight`>>	Fuel economy.
`END`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Duration`>>	Endurance (time to zero fuel).
`ENR`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Duration`>>	Estimated time enroute to destination.
`ETA`	`NavDataFieldModel`<`number`>	Estimated time of arrival at next waypoint.
`ETE`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Duration`>>	Estimated time enroute to next waypoint.
`ETV`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Duration`>>	Estimated time to VNAV intercept.
`FF`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.WeightFlux`>>	Fuel flow.
`FL`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Distance`>>	Flight level.
`FOB`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Weight`>>	Total fuel remaining.
`FOD`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Weight`>>	Estimated fuel remaining at destination.
`G`	`NavDataFieldModel`<`number`>	G meter.
`GPSA`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Distance`>>	GPS Altitude.
`GR`	`NavDataFieldModel`<`number`>	Glide ratio.
`GS`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Speed`>>	Ground speed.
`ISA`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.TemperatureDelta`>>	International standard atmosphere.
`LCL`	`NavDataFieldModel`<`number`>	Local time.
`LDG`	`NavDataFieldModel`<`number`>	Estimated time of arrival at destination.
`MACH`	`NavDataFieldModel`<`number`>	Mach number.
`OAT`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Temperature`>>	Outside air temperature.
`RAT`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Temperature`>>	Ram air temperature.
`TAS`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Speed`>>	True airspeed.
`TKE`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Angle`>>	Track angle error.
`TRK`	`NavDataFieldModel`<`NumberUnitInterface`<`NavAngleUnitFamily`, `NavAngleUnit`>>	Ground track.
`USD`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Weight`>>	Fuel used.
`UTC`	`NavDataFieldModel`<`number`>	UTC time.
`VSR`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Speed`>>	Vertical speed required to meet next VNAV restriction.
`WPT`	`NavDataFieldModel`<`string`>	Next waypoint ident.
`XTK`	`NavDataFieldModel`<`NumberUnitInterface`<`UnitFamily.Distance`>>	Cross-track error.

Defined in

src/garminsdk/components/navdatafield/NavDataFieldType.ts:54

NavStatusBoxFieldType

Ƭ NavStatusBoxFieldType: BearingToWaypoint | DistanceToWaypoint | TimeToWaypoint

A type of data field supported by the navigation status box.

Defined in

src/garminsdk/components/nextgenpfd/navstatusbox/NavStatusBoxFieldType.ts:6

NavStatusBoxFieldTypeModelMap

Ƭ NavStatusBoxFieldTypeModelMap: { [Type in NavStatusBoxFieldType]: NavStatusBoxFieldModel<NavDataFieldTypeModelMap[Type] extends NavDataFieldModel<infer T> ? T : never> }

src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:30

NextGenNavMapOptions

Ƭ NextGenNavMapOptions: Object

Options for creating a next-generation (NXi, G3000, etc) Garmin navigation map.

Type declaration

Name	Type	Description
`airplaneIconAnchor`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The point on the player airplane icon that is anchored to the airplane's position, or a subscribable which provides it. The point is expressed as a 2-tuple relative to the icon's width and height, with [0, 0] at the top left and [1, 1] at the bottom right.
`airplaneIconOrientation?`	`MapOwnAirplaneIconOrientation` \| `Subscribable`<`MapOwnAirplaneIconOrientation`>	The orientation of the player airplane icon. Defaults to `MapOwnAirplaneIconOrientation.HeadingUp`.
`airplaneIconSize`	`number`	The size of the player airplane icon, in pixels.
`airplaneIconSrc`	`string` \| `Subscribable`<`string`>	The URI of the player airplane icon's image asset
`allowRelativeTerrainMode?`	`boolean`	Whether to allow relative terrain mode. Defaults to `true`. Ignored if `useTerrainUserSettings` is `false` or `settingManager` is not defined.
`bingDelay?`	`number`	The amount of time, in milliseconds, to delay binding the map's Bing Map instance. Defaults to 0.
`bingId`	`string`	The ID to assign to the map's bound Bing Map instance.
`dataUpdateFreq`	`number` \| `Subscribable`<`number`>	The frequency, in hertz, with which player airplane and autopilot properties are updated from event bus data.
`defaultFocusRangeIndex?`	`number`	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).
`drawEntirePlan?`	`boolean` \| `Subscribable`<`boolean`>	Whether to always draw the entire active flight plan, or a subscribable which provides it. Defaults to `false`. Ignored if the active flight plan is not displayed.
`flightPlanner?`	`FlightPlanner`	The flight planner containing the active flight plan. Required to display the active flight plan.
`groundRelativeTerrainBlendDuration?`	`number`	The amount of time, in milliseconds, over which to blend the on-ground and relative terrain mode colors when transitioning between the two. Defaults to 10000 milliseconds.
`includeAirspaces?`	`boolean`	Whether to display airspaces. Defaults to `true`.
`includeAltitudeArc?`	`boolean`	Whether to include the altitude intercept arc display. Defaults to `true`.
`includeDetailIndicator?`	`boolean`	Whether to include a detail indicator. Defaults to `true`.
`includeOrientationIndicator?`	`boolean`	Whether to include an orientation indicator. Defaults to `true`.
`includeRangeIndicator?`	`boolean`	Whether to include a map range indicator. Defaults to `false`.
`includeRunwayOutlines?`	`boolean`	Whether to display airport runway outlines. Defaults to `false`.
`includeTerrainScale?`	`boolean`	Whether to include a terrain scale indicator. Defaults to `true`.
`includeTrackVector?`	`boolean`	Whether to include the track vector display. Defaults to `true`.
`includeTrafficFailedIndicator?`	`boolean`	Whether to include a traffic failed mode indicator. Defaults to `true`.
`includeTrafficOffScaleIndicator?`	`boolean`	Whether to include a traffic off-scale status indicator. Defaults to `true`.
`includeTrafficStatusIndicator?`	`boolean`	Whether to include a traffic status indicator. Defaults to `true`.
`includeWindVector?`	`boolean`	Whether to include the wind vector display. Defaults to `true`. Ignored if `windDataProvider` is not defined.
`lnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the LNAV from which to source data. Defaults to `0`.
`metricRangeArray?`	readonly `NumberUnitInterface`<`UnitFamily.Distance`>[]	The map range array to use for metric units mode. Defaults to a standard range array.
`miniCompassImgSrc?`	`string`	The URI of the mini-compass's image asset. Required to display the mini-compass.
`nauticalRangeArray?`	readonly `NumberUnitInterface`<`UnitFamily.Distance`>[]	The map range array to use for nautical units mode. Defaults to a standard range array.
`nexradMinRangeIndex?`	`number`	The minimum range index, inclusive, at which NEXRAD is visible.
`noGpsBannerText?`	`string`	The text of the banner that is displayed when GPS position is not available. Defaults to `'NO GPS POSITION'`.
`noHeadingAirplaneIconAnchor?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The point on the no-heading player airplane icon that is anchored to the airplane's position, or a subscribable which provides it. The point is expressed as a 2-tuple relative to the icon's width and height, with [0, 0] at the top left and [1, 1] at the bottom right.
`noHeadingAirplaneIconSrc?`	`string` \| `Subscribable`<`string`>	The URI of the no-heading player airplane icon's image asset, or a subscribable which provides it.
`nominalFocusMargins?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	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]`.
`pointerBoundsOffset?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The offset of the boundary surrounding the area in which the pointer can freely move, from the edge of the projected map, excluding the dead zone, or a subscribable which provides it. Expressed as `[left, top, right, bottom]`, relative to the width and height, as appropriate, of the projected map window. A positive offset is directed toward the center of the map. Required to support the map pointer.
`pointerInfoSize?`	`MapPointerInfoLayerSize`	The size of the pointer information box. Required to display the pointer information box. Ignored if the map pointer is not supported.
`rangeCompassOptions`	`RangeCompassOptions`	Styling options for the range compass.
`rangeEndpoints?`	`Partial`<`Record`<`MapOrientation`, `ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>>>	The range endpoints of the map for each orientation mode, as `[x1, y1, x2, y2]`, where each component is expressed relative to the width or height of the map's projected window, excluding the dead zone. Defaults to the following: `{ [MapOrientation.NorthUp]: [0.5, 0.5, 0.5, 0.25], [MapOrientation.HeadingUp]: [0.5, 0.67, 0.5, 0.33], [MapOrientation.TrackUp]: [0.5, 0.67, 0.5, 0.33] }`
`rangeRingOptions`	`RangeRingOptions`	Styling options for the range ring.
`relativeTerrainStatusIndicatorIconPath?`	`string`	The path to the relative terrain mode status indicator icon's image file. Required to include the relative terrain mode status indicator.
`runwayDesignationImageCache?`	`MapRunwayDesignationImageCache`	The image cache from which to retrieve runway designation images. If not defined, runway designations will not be rendered. Ignored if `includeRunwayOutlines` is `false`.
`settingManager?`	`UserSettingManager`<`Partial`<`MapUserSettingTypes`>>	A user setting manager containing map settings. If not defined, map options will not be controlled by user settings.
`showDetailIndicatorTitle?`	`boolean`	Whether to show the detail indicator title. Defaults to `true`. Ignored if `includeDetailIndicator` is `false`.
`showTrafficAltRestriction?`	`boolean`	Whether to show the traffic altitude restriction mode on the traffic status indicator. Defaults to `true`. Ignored if `includeTrafficStatusIndicator` is `false`.
`supportDataIntegrity?`	`boolean`	Whether to support data integrity state. Defaults to `true`.
`supportFlightPlanFocus?`	`boolean`	Whether to support flight plan focus. Defaults to `false`. Ignored if the active flight plan is not displayed.
`targetOffsets?`	`Partial`<`Record`<`MapOrientation`, `ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>>>	The nominal projected target offset of the map for each orientation mode, 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 the following: `{ [MapOrientation.NorthUp]: [0, 0], [MapOrientation.HeadingUp]: [0, 0.17], [MapOrientation.TrackUp]: [0, 0.17] }`
`trafficIconOptions?`	`NextGenNavMapTrafficIconOptions`	Configuration options for traffic icons. Required to display traffic.
`trafficSettingManager?`	`UserSettingManager`<`Partial`<`TrafficUserSettingTypes`>>	A user setting manager containing settings controlling the operation of the traffic system. If not defined, certain traffic display options will not be controlled by user settings.
`trafficSystem?`	`TrafficSystem`	The traffic system from which to retrieve traffic intruder data. Required to display traffic.
`unitsSettingManager?`	`UnitsUserSettingManager`	A display units user setting manager. If not defined, map display units will not be controlled by user settings.
`useAirspaceVisUserSettings?`	`boolean`	Whether to bind airspace visibility to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useAltitudeArcUserSettings?`	`boolean`	Whether to bind altitude intercept arc options to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useDeclutterUserSetting?`	`boolean`	Whether to bind the global declutter function to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useNexradUserSettings?`	`boolean`	Whether to bind the display of NEXRAD to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useOrientationUserSettings?`	`boolean`	Whether to bind map orientation to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useRangeUserSettingByDefault?`	`boolean`	Whether the map's range should be controlled by user setting by default. Defaults to `true`.
`useTerrainUserSettings?`	`boolean`	Whether to bind terrain colors to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useTrackVectorUserSettings?`	`boolean`	Whether to bind track vector options to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useWaypointVisUserSettings?`	`boolean`	Whether to bind waypoint visibility to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useWindVectorUserSettings?`	`boolean`	Whether to bind wind vector options to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`vnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the VNAV from which to source data. Defaults to `0`.
`waypointIconImageCache`	`WaypointIconImageCache`	The image cache from which to retrieve waypoint icon images.
`waypointStyleFontType`	`"Roboto"` \| `"DejaVu"`	The font type to use for waypoint labels.
`waypointStyleScale?`	`number`	The scaling factor of waypoint icons and labels. Defaults to `1`.
`windDataProvider?`	`WindDataProvider`	A provider of wind data for the wind vector. Required to display the wind vector.

Defined in

src/garminsdk/components/map/assembled/NextGenNavMapBuilder.tsx:44

NextGenNavMapTrafficIconOptions

Ƭ NextGenNavMapTrafficIconOptions: Pick<TrafficIconOptions, "iconSize" | "font" | "fontSize"> & Partial<Pick<TrafficIconOptions, "supportAdsbVector">>

Configurations for traffic intruder icons for next-generation (NXi, G3000, etc) navigation maps.

Defined in

src/garminsdk/components/map/assembled/NextGenNavMapBuilder.tsx:38

NextGenNearestMapOptions

Ƭ NextGenNearestMapOptions: Object

Options for creating a next-generation (NXi, G3000, etc) Garmin nearest waypoint map.

Type declaration

Name	Type	Description
`airplaneIconAnchor`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The point on the player airplane icon that is anchored to the airplane's position, or a subscribable which provides it. The point is expressed as a 2-tuple relative to the icon's width and height, with [0, 0] at the top left and [1, 1] at the bottom right.
`airplaneIconOrientation?`	`MapOwnAirplaneIconOrientation` \| `Subscribable`<`MapOwnAirplaneIconOrientation`>	The orientation of the player airplane icon. Defaults to `MapOwnAirplaneIconOrientation.HeadingUp`.
`airplaneIconSize`	`number`	The size of the player airplane icon, in pixels.
`airplaneIconSrc`	`string` \| `Subscribable`<`string`>	The URI of the player airplane icon's image asset
`allowRelativeTerrainMode?`	`boolean`	Whether to allow relative terrain mode. Defaults to `false`. Ignored if `useTerrainUserSettings` is `false` or `settingManager` is not defined.
`bingDelay?`	`number`	The amount of time, in milliseconds, to delay binding the map's Bing Map instance. Defaults to 0.
`bingId`	`string`	The ID to assign to the map's bound Bing Map instance.
`dataUpdateFreq`	`number` \| `Subscribable`<`number`>	The frequency, in hertz, with which player airplane and autopilot properties are updated from event bus data.
`defaultNoTargetRangeIndex?`	`number` \| `Subscribable`<`number`> \| `null`	The default map range index to apply when there is no highlighted waypoint, or `null` if no range index should be applied. Defaults to `null`.
`flightPlanner?`	`FlightPlanner`	The flight planner containing the active flight plan. Required to display the active flight plan.
`groundRelativeTerrainBlendDuration?`	`number`	The amount of time, in milliseconds, over which to blend the on-ground and relative terrain mode colors when transitioning between the two. Defaults to 10000 milliseconds.
`includeAirspaces?`	`boolean`	Whether to display airspaces. Defaults to `true`.
`includeAltitudeArc?`	`boolean`	Whether to include the altitude intercept arc display. Defaults to `true`.
`includeDetailIndicator?`	`boolean`	Whether to include a detail indicator. Defaults to `true`.
`includeOrientationIndicator?`	`boolean`	Whether to include an orientation indicator. Defaults to `true`.
`includeRangeIndicator?`	`boolean`	Whether to include a map range indicator. Defaults to `false`.
`includeRunwayOutlines?`	`boolean`	Whether to display airport runway outlines. Defaults to `false`.
`includeTerrainScale?`	`boolean`	Whether to include a terrain scale indicator. Defaults to `true`.
`includeTrackVector?`	`boolean`	Whether to include the track vector display. Defaults to `true`.
`includeTrafficFailedIndicator?`	`boolean`	Whether to include a traffic failed mode indicator. Defaults to `true`.
`includeTrafficOffScaleIndicator?`	`boolean`	Whether to include a traffic off-scale status indicator. Defaults to `true`.
`includeTrafficStatusIndicator?`	`boolean`	Whether to include a traffic status indicator. Defaults to `true`.
`includeWindVector?`	`boolean`	Whether to include the wind vector display. Defaults to `true`. Ignored if `windDataProvider` is not defined.
`lineOptions?`	`Readonly`<`WaypointHighlightLineOptions`>	Styling options for the waypoint highlight line.
`lnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the LNAV from which to source data. Defaults to `0`.
`metricRangeArray?`	readonly `NumberUnitInterface`<`UnitFamily.Distance`>[]	The map range array to use for metric units mode. Defaults to a standard range array.
`miniCompassImgSrc?`	`string`	The URI of the mini-compass's image asset. Required to display the mini-compass.
`nauticalRangeArray?`	readonly `NumberUnitInterface`<`UnitFamily.Distance`>[]	The map range array to use for nautical units mode. Defaults to a standard range array.
`nexradMinRangeIndex?`	`number`	The minimum range index, inclusive, at which NEXRAD is visible.
`noGpsBannerText?`	`string`	The text of the banner that is displayed when GPS position is not available. Defaults to `'NO GPS POSITION'`.
`noHeadingAirplaneIconAnchor?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The point on the no-heading player airplane icon that is anchored to the airplane's position, or a subscribable which provides it. The point is expressed as a 2-tuple relative to the icon's width and height, with [0, 0] at the top left and [1, 1] at the bottom right.
`noHeadingAirplaneIconSrc?`	`string` \| `Subscribable`<`string`>	The URI of the no-heading player airplane icon's image asset, or a subscribable which provides it.
`pointerBoundsOffset?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The offset of the boundary surrounding the area in which the pointer can freely move, from the edge of the projected map, excluding the dead zone, or a subscribable which provides it. Expressed as `[left, top, right, bottom]`, relative to the width and height, as appropriate, of the projected map window. A positive offset is directed toward the center of the map. Required to support the map pointer.
`pointerInfoSize?`	`MapPointerInfoLayerSize`	The size of the pointer information box. Required to display the pointer information box. Ignored if the map pointer is not supported.
`rangeCompassOptions`	`RangeCompassOptions`	Styling options for the range compass.
`rangeEndpoints?`	`Partial`<`Record`<`MapOrientation`, `ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>>>	The range endpoints of the map for each orientation mode, as `[x1, y1, x2, y2]`, where each component is expressed relative to the width or height of the map's projected window, excluding the dead zone. Defaults to the following: `{ [MapOrientation.NorthUp]: [0.5, 0.5, 0.5, 0.25], [MapOrientation.HeadingUp]: [0.5, 0.67, 0.5, 0.33], [MapOrientation.TrackUp]: [0.5, 0.67, 0.5, 0.33] }`
`rangeRingOptions`	`RangeRingOptions`	Styling options for the range ring.
`relativeTerrainStatusIndicatorIconPath?`	`string`	The path to the relative terrain mode status indicator icon's image file. Required to include the relative terrain mode status indicator.
`runwayDesignationImageCache?`	`MapRunwayDesignationImageCache`	The image cache from which to retrieve runway designation images. If not defined, runway designations will not be rendered. Ignored if `includeRunwayOutlines` is `false`.
`settingManager?`	`UserSettingManager`<`Partial`<`MapUserSettingTypes`>>	A user setting manager containing map settings. If not defined, map options will not be controlled by user settings.
`showDetailIndicatorTitle?`	`boolean`	Whether to show the detail indicator title. Defaults to `true`. Ignored if `includeDetailIndicator` is `false`.
`showTrafficAltRestriction?`	`boolean`	Whether to show the traffic altitude restriction mode on the traffic status indicator. Defaults to `true`. Ignored if `includeTrafficStatusIndicator` is `false`.
`supportDataIntegrity?`	`boolean`	Whether to support data integrity state. Defaults to `true`.
`targetOffsets?`	`Partial`<`Record`<`MapOrientation`, `ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>>>	The nominal projected target offset of the map for each orientation mode, 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 the following: `{ [MapOrientation.NorthUp]: [0, 0], [MapOrientation.HeadingUp]: [0, 0.17], [MapOrientation.TrackUp]: [0, 0.17] }`
`trafficIconOptions?`	`NextGenNearestMapTrafficIconOptions`	Configuration options for traffic icons. Required to display traffic.
`trafficSettingManager?`	`UserSettingManager`<`Partial`<`TrafficUserSettingTypes`>>	A user setting manager containing settings controlling the operation of the traffic system. If not defined, certain traffic display options will not be controlled by user settings.
`trafficSystem?`	`TrafficSystem`	The traffic system from which to retrieve traffic intruder data. Required to display traffic.
`unitsSettingManager?`	`UnitsUserSettingManager`	A display units user setting manager. If not defined, map display units will not be controlled by user settings.
`useAirspaceVisUserSettings?`	`boolean`	Whether to bind airspace visibility to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useAltitudeArcUserSettings?`	`boolean`	Whether to bind altitude intercept arc options to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useDeclutterUserSetting?`	`boolean`	Whether to bind the global declutter function to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useNexradUserSettings?`	`boolean`	Whether to bind the display of NEXRAD to user settings. Defaults to `false`. Ignored if `settingManager` is not defined.
`useOrientationUserSettings?`	`boolean`	Whether to bind map orientation to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useRangeUserSettingByDefault?`	`boolean`	Whether the map's range should be controlled by user setting by default. Defaults to `true`.
`useTerrainUserSettings?`	`boolean`	Whether to bind terrain colors to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useTrackVectorUserSettings?`	`boolean`	Whether to bind track vector options to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useWaypointVisUserSettings?`	`boolean`	Whether to bind waypoint visibility to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useWindVectorUserSettings?`	`boolean`	Whether to bind wind vector options to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`vnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the VNAV from which to source data. Defaults to `0`.
`waypointIconImageCache`	`WaypointIconImageCache`	The image cache from which to retrieve waypoint icon images.
`waypointStyleFontType`	`"Roboto"` \| `"DejaVu"`	The font type to use for waypoint labels.
`waypointStyleScale?`	`number`	The scaling factor of waypoint icons and labels. Defaults to `1`.
`windDataProvider?`	`WindDataProvider`	A provider of wind data for the wind vector. Required to display the wind vector.

Defined in

src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:44

NextGenNearestMapTrafficIconOptions

Ƭ NextGenNearestMapTrafficIconOptions: Pick<TrafficIconOptions, "iconSize" | "font" | "fontSize"> & Partial<Pick<TrafficIconOptions, "supportAdsbVector">>

Configurations for traffic intruder icons for next-generation (NXi, G3000, etc) nearest waypoint maps.

Defined in

src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:38

NextGenProcMapOptions

Ƭ NextGenProcMapOptions: Object

Options for creating a next-generation (NXi, G3000, etc) Garmin procedure map.

Type declaration

Name	Type	Description
`airplaneIconAnchor`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The point on the player airplane icon that is anchored to the airplane's position, or a subscribable which provides it. The point is expressed as a 2-tuple relative to the icon's width and height, with [0, 0] at the top left and [1, 1] at the bottom right.
`airplaneIconOrientation?`	`MapOwnAirplaneIconOrientation` \| `Subscribable`<`MapOwnAirplaneIconOrientation`>	The orientation of the player airplane icon. Defaults to `MapOwnAirplaneIconOrientation.HeadingUp`.
`airplaneIconSize`	`number`	The size of the player airplane icon, in pixels.
`airplaneIconSrc`	`string` \| `Subscribable`<`string`>	The URI of the player airplane icon's image asset
`allowRelativeTerrainMode?`	`boolean`	Whether to allow relative terrain mode. Defaults to `true`. Ignored if `useTerrainUserSettings` is `false` or `settingManager` is not defined.
`bingDelay?`	`number`	The amount of time, in milliseconds, to delay binding the map's Bing Map instance. Defaults to 0.
`bingId`	`string`	The ID to assign to the map's bound Bing Map instance.
`dataUpdateFreq`	`number` \| `Subscribable`<`number`>	The frequency, in hertz, with which the player airplane's properties are updated from event bus data.
`defaultFocusRangeIndex?`	`number`	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).
`includeOrientationIndicator?`	`boolean`	Whether to include an orientation indicator. Defaults to `true`.
`metricRangeArray?`	readonly `NumberUnitInterface`<`UnitFamily.Distance`>[]	The map range array to use for metric units mode. Defaults to a standard range array.
`miniCompassImgSrc?`	`string`	The URI of the mini-compass's image asset. Required to display the mini-compass.
`nauticalRangeArray?`	readonly `NumberUnitInterface`<`UnitFamily.Distance`>[]	The map range array to use for nautical units mode. Defaults to a standard range array.
`noGpsBannerText?`	`string`	The text of the banner that is displayed when GPS position is not available. Defaults to `'NO GPS POSITION'`.
`noHeadingAirplaneIconAnchor?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The point on the no-heading player airplane icon that is anchored to the airplane's position, or a subscribable which provides it. The point is expressed as a 2-tuple relative to the icon's width and height, with [0, 0] at the top left and [1, 1] at the bottom right.
`noHeadingAirplaneIconSrc?`	`string` \| `Subscribable`<`string`>	The URI of the no-heading player airplane icon's image asset, or a subscribable which provides it.
`nominalFocusMargins?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	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]`.
`pointerBoundsOffset?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The offset of the boundary surrounding the area in which the pointer can freely move, from the edge of the projected map, excluding the dead zone, or a subscribable which provides it. Expressed as `[left, top, right, bottom]`, relative to the width and height, as appropriate, of the projected map window. A positive offset is directed toward the center of the map. Required to support the map pointer.
`pointerInfoSize?`	`MapPointerInfoLayerSize`	The size of the pointer information box. Required to display the pointer information box. Ignored if the map pointer is not supported.
`rangeEndpoints?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The range endpoints of the map, as `[x1, y1, x2, y2]`, where each component is expressed relative to the width or height of the map's projected window, excluding the dead zone. Defaults to `[0.5, 0.5, 0.5, 0.25]`.
`rangeRingOptions`	`RangeRingOptions`	Styling options for the range ring.
`settingManager?`	`UserSettingManager`<`Partial`<`MapUserSettingTypes`>>	A user setting manager containing map settings. If not defined, map options will not be controlled by user settings.
`supportDataIntegrity?`	`boolean`	Whether to support data integrity state. Defaults to `true`.
`targetOffset?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	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?`	`UnitsUserSettingManager`	A display units user setting manager. If not defined, map display units will not be controlled by user settings.
`useDeclutterUserSetting?`	`boolean`	Whether to bind the global declutter function to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useTerrainUserSettings?`	`boolean`	Whether to bind terrain colors to user settings. Defaults to `false`. Ignored if `settingManager` is not defined.
`waypointIconImageCache`	`WaypointIconImageCache`	The image cache from which to retrieve waypoint icon images.
`waypointStyleFontType`	`"Roboto"` \| `"DejaVu"`	The font type to use for waypoint labels.
`waypointStyleScale?`	`number`	The scaling factor of waypoint icons and labels. Defaults to `1`.

Type declaration

Name	Type	Description
`airplaneIconAnchor`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The point on the player airplane icon that is anchored to the airplane's position, or a subscribable which provides it. The point is expressed as a 2-tuple relative to the icon's width and height, with [0, 0] at the top left and [1, 1] at the bottom right.
`airplaneIconOrientation?`	`MapOwnAirplaneIconOrientation` \| `Subscribable`<`MapOwnAirplaneIconOrientation`>	The orientation of the player airplane icon. Defaults to `MapOwnAirplaneIconOrientation.HeadingUp`.
`airplaneIconSize`	`number`	The size of the player airplane icon, in pixels.
`airplaneIconSrc`	`string` \| `Subscribable`<`string`>	The URI of the player airplane icon's image asset, or a subscribable which provides it
`airportAutoRangeMargins?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The nominal margins (relative to the map's dead zone boundaries), to respect when calculating the map range for airports, as `[left, top, right, bottom]` in pixels. Ignored if `supportAirportAutoRange` is `false`. Defaults to `[0, 0, 0, 0]`.
`allowRelativeTerrainMode?`	`boolean`	Whether to allow relative terrain mode. Defaults to `false`. Ignored if `useTerrainUserSettings` is `false` or `settingManager` is not defined.
`bingDelay?`	`number`	The amount of time, in milliseconds, to delay binding the map's Bing Map instance. Defaults to 0.
`bingId`	`string`	The ID to assign to the map's bound Bing Map instance.
`dataUpdateFreq`	`number` \| `Subscribable`<`number`>	The frequency, in hertz, with which the player airplane's properties are updated from event bus data.
`defaultAirportRangeIndex?`	`number` \| `Subscribable`<`number`>	The default map range index to apply when a range cannot be automatically selected for an airport. Ignored if `supportAirportAutoRange` is `false`. If not defined, the map range will not be reset when targeting an airport and a range cannot be automatically selected.
`flightPlanner?`	`FlightPlanner`	The flight planner containing the active flight plan. Required to display the active flight plan.
`groundRelativeTerrainBlendDuration?`	`number`	The amount of time, in milliseconds, over which to blend the on-ground and relative terrain mode colors when transitioning between the two. Defaults to 2000 milliseconds.
`includeAirspaces?`	`boolean`	Whether to display airspaces. Defaults to `false`.
`includeDetailIndicator?`	`boolean`	Whether to include a detail indicator. Defaults to `false`.
`includeLine?`	`boolean`	Whether the map draws a line from the highlighted waypoint to the player airplane. Defaults to `false`.
`includeOrientationIndicator?`	`boolean`	Whether to include an orientation indicator. Defaults to `true`.
`includeRunwayOutlines?`	`boolean`	Whether to display airport runway outlines. Defaults to `false`.
`lineOptions?`	`WaypointHighlightLineOptions`	Styling options for the waypoint highlight line. Ignored if `includeLine` is `false`.
`lnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the LNAV from which to source data. Defaults to `0`.
`metricRangeArray?`	readonly `NumberUnitInterface`<`UnitFamily.Distance`>[]	The map range array to use for metric units mode. Defaults to a standard range array.
`miniCompassImgSrc?`	`string`	The URI of the mini-compass's image asset. Required to display the mini-compass.
`nauticalRangeArray?`	readonly `NumberUnitInterface`<`UnitFamily.Distance`>[]	The map range array to use for nautical units mode. Defaults to a standard range array.
`nexradMinRangeIndex?`	`number`	The minimum range index, inclusive, at which NEXRAD is visible.
`noGpsBannerText?`	`string`	The text of the banner that is displayed when GPS position is not available. Defaults to `'NO GPS POSITION'`.
`noHeadingAirplaneIconAnchor?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The point on the no-heading player airplane icon that is anchored to the airplane's position, or a subscribable which provides it. The point is expressed as a 2-tuple relative to the icon's width and height, with [0, 0] at the top left and [1, 1] at the bottom right.
`noHeadingAirplaneIconSrc?`	`string` \| `Subscribable`<`string`>	The URI of the no-heading player airplane icon's image asset, or a subscribable which provides it.
`pointerBoundsOffset?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The offset of the boundary surrounding the area in which the pointer can freely move, from the edge of the projected map, excluding the dead zone, or a subscribable which provides it. Expressed as `[left, top, right, bottom]`, relative to the width and height, as appropriate, of the projected map window. A positive offset is directed toward the center of the map. Required to support the map pointer.
`pointerInfoSize?`	`MapPointerInfoLayerSize`	The size of the pointer information box. Required to display the pointer information box. Ignored if the map pointer is not supported.
`rangeEndpoints?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The range endpoints of the map, as `[x1, y1, x2, y2]`, where each component is expressed relative to the width or height of the map's projected window, excluding the dead zone. Defaults to `[0.5, 0.5, 0.5, 0.25]`.
`rangeRingOptions`	`RangeRingOptions`	Styling options for the range ring.
`runwayDesignationImageCache?`	`MapRunwayDesignationImageCache`	The image cache from which to retrieve runway designation images. If not defined, runway designations will not be rendered. Ignored if `includeRunwayOutlines` is `false`.
`settingManager?`	`UserSettingManager`<`Partial`<`MapUserSettingTypes`>>	A user setting manager containing map settings. If not defined, map options will not be controlled by user settings.
`showDetailIndicatorTitle?`	`boolean`	Whether to show the detail indicator title. Defaults to `false`. Ignored if `includeDetailIndicator` is `false`.
`supportAirportAutoRange?`	`boolean`	Whether the map should automatically adjust its range when the selected waypoint is an airport to give an appropriate view of the selected runway, or all runways if there is no selected runway. Defaults to `false`.
`supportDataIntegrity?`	`boolean`	Whether to support data integrity state. Defaults to `true`.
`targetOffset?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	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?`	`UnitsUserSettingManager`	A display units user setting manager. If not defined, map display units will not be controlled by user settings.
`useAirspaceVisUserSettings?`	`boolean`	Whether to bind airspace visibility to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useDeclutterUserSetting?`	`boolean`	Whether to bind the global declutter function to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useNexradUserSettings?`	`boolean`	Whether to bind the display of NEXRAD to user settings. Defaults to `false`. Ignored if `settingManager` is not defined.
`useTerrainUserSettings?`	`boolean`	Whether to bind terrain colors to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`useWaypointVisUserSettings?`	`boolean`	Whether to bind waypoint visibility to user settings. Defaults to `true`. Ignored if `settingManager` is not defined.
`vnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the VNAV from which to source data. Defaults to `0`.
`waypointIconImageCache`	`WaypointIconImageCache`	The image cache from which to retrieve waypoint icon images.
`waypointStyleFontType`	`"Roboto"` \| `"DejaVu"`	The font type to use for waypoint labels.
`waypointStyleScale?`	`number`	The scaling factor of waypoint icons and labels. Defaults to `1`.

Defined in

src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:27

NumberUnitNavDataFieldTypes

Ƭ NumberUnitNavDataFieldTypes: keyof { [P in NavDataFieldType as NavDataFieldTypeModelMap[P] extends NavDataFieldModel<NumberUnitInterface<string>> ? P : never]: P }

Type declaration

Name	Type	Description
`lowBankAngle?`	`number`	The bank angle limit, in degrees, in Low Bank Mode. If not defined, the low-bank arc will not be displayed.
`majorTickLength`	`number`	The length of the major roll scale ticks, in pixels.
`minorTickLength`	`number`	The length of the minor roll scale ticks, in pixels.
`pointerStyle`	`"ground"` \| `"sky"`	Whether to render the indicator with a ground pointer or a sky pointer. With a ground pointer, the roll scale rotates as the airplane banks to keep the zero-roll reference pointer pointed toward the ground while the roll pointer remains fixed. With a sky pointer, the roll pointer rotates as the airplane banks to keep itself pointed toward the sky while the roll scale remains fixed.
`radius`	`number`	The radius of the roll scale, in pixels.
`referencePointerOffset`	`number`	The offset of the tip of the zero-roll reference pointer from the roll scale, in pixels. Positive values displace the pointer away from the center of the circle circumscribed by the roll scale.
`referencePointerSize`	`ReadonlyFloat64Array`	The size of the zero-roll reference pointer, as `[width, height]` in pixels.
`rollPointerOffset`	`number`	The offset of the tip of the roll pointer from the roll scale, in pixels. Positive values displace the pointer toward the center of the circle circumscribed by the roll scale.
`rollPointerSize`	`ReadonlyFloat64Array`	The size of the roll pointer, as `[width, height]` in pixels.
`showArc`	`boolean`	Whether to render the roll arc.
`slipSkidIndicatorHeight`	`number`	The height of the slip/skid indicator, in pixels.
`slipSkidIndicatorOffset`	`number`	The offset of the slip/skid indicator from the roll pointer, in pixels. Values less than 0 will be clamped to 0.
`slipSkidIndicatorTranslateScale`	`number`	The amount to translate the slip/skid indicator, in pixels, at full deflection.

Defined in

src/garminsdk/components/nextgenpfd/horizon/RollIndicator.tsx:10

SpeedConstraintListItem

Ƭ SpeedConstraintListItem: Object

A item containing a speed constraint from a flight plan and associated metadata.

Type declaration

Name	Type	Description
`flightPhase`	`VerticalFlightPhase`	The vertical flight phase of this item's speed constraint.
`globalLegIndex`	`number`	The global index of the flight plan leg associated with this item's speed constraint.
`isMissedApproach`	`boolean`	Whether this item's speed constraint is part of a missed approach procedure.
`speedConstraint`	`Readonly`<`SpeedConstraint`>	This item's speed constraint.

Defined in

src/garminsdk/autopilot/GarminSpeedConstraintStore.ts:11

SynVisUserSettingTypes

Ƭ SynVisUserSettingTypes: Object

Synthetic vision technology (SVT) user settings.

Type declaration

Name	Type	Description
`svtAirportSignShow`	`boolean`	Whether to show SVT airport signs.
`svtDisabledFpmShow`	`boolean`	Whether to show the flight path marker when SVT is disabled.
`svtEnabled`	`boolean`	Whether SVT is enabled.
`svtHeadingLabelShow`	`boolean`	Whether to show SVT horizon heading labels.
`svtPathwaysShow`	`boolean`	Whether to show SVT pathways.
`svtTrafficShow`	`boolean`	Whether to show SVT traffic.

Defined in

src/garminsdk/settings/SynVisUserSettings.ts:4

TcasRaPitchCueLayerOptions

Ƭ TcasRaPitchCueLayerOptions: Pick<TcasRaPitchCueLayerProps, "clipBounds" | "conformalBounds" | "tasSmoothingTau" | "pitchSmoothingTau">

Options for the TCAS resolution advisory pitch cue layer.

Defined in

src/garminsdk/components/nextgenpfd/horizon/HorizonDisplay.tsx:70

TerrainSystemAnnunciationDef

Ƭ TerrainSystemAnnunciationDef: Object

A definition describing a terrain alerting system annunciation.

Type declaration

Name	Type	Description
`level`	`TerrainSystemAnnunciationLevel`	The level of the annunciation.
`text`	`string`	The text to display for the annunciation.

Defined in

src/garminsdk/components/terrain/TerrainSystemAnnunciation.tsx:17

TerrainSystemAnnunciationPriorityDef

Ƭ TerrainSystemAnnunciationPriorityDef: TerrainSystemAnnunciationDef & { priority: number }

Type declaration

Name	Type	Description
`adsb?`	`GarminAdsb` \| `null`	The ADS-B system associated with the TIS, or `null` if the TIS does not support ADS-B.
`adsbMaxIntruderCount?`	`number`	The maximum number of intruders tracked at any one time by the TIS when ADS-B is available. Defaults to TrafficInfoService.DEFAULT_ADSB_MAX_INTRUDER_COUNT.
`adsbRealTimeUpdateFreq?`	`number`	The maximum update frequency (Hz) in real time when ADS-B is available. Defaults to TrafficInfoService.DEFAULT_ADSB_REAL_TIME_UPDATE_FREQ.
`adsbSimTimeUpdateFreq?`	`number`	The maximum update frequency (Hz) in sim time when ADS-B is available. Defaults to TrafficInfoService.DEFAULT_ADSB_SIM_TIME_UPDATE_FREQ.
`maxIntruderCount?`	`number`	The maximum number of intruders tracked at any one time by the TIS when ADS-B is not available. Defaults to TrafficInfoService.DEFAULT_MAX_INTRUDER_COUNT.
`realTimeUpdateFreq?`	`number`	The maximum update frequency (Hz) in real time when ADS-B is not available. Defaults to TrafficInfoService.DEFAULT_REAL_TIME_UPDATE_FREQ.
`simTimeUpdateFreq?`	`number`	The maximum update frequency (Hz) in sim time when ADS-B is not available. Defaults to TrafficInfoService.DEFAULT_SIM_TIME_UPDATE_FREQ.
`supportGpsFlightPhase?`	`boolean`	Whether the ADS-B traffic alerting algorithm supports using GPS phase of flight information to select sensitivity levels. Ignored if ADS-B is not supported. Defaults to `false`.
`supportRadarAltitude?`	`boolean`	Whether the TIS supports radar altitude. Defaults to `false`.

Defined in

src/garminsdk/traffic/TrafficInfoService.ts:18

TrafficMapOptions

Ƭ TrafficMapOptions: Object

Options for creating a Garmin traffic map.

Type declaration

Name	Type	Description
`adsbModeText?`	`Partial`<`Record`<`AdsbOperatingMode`, `string`>>	The text to display in the ADS-B operating mode indicator for each operating mode. Ignored if ADS-B is not supported.
`airplaneIconAnchor`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The point on the player airplane icon that is anchored to the airplane's position, or a subscribable which provides it. The point is expressed as a 2-tuple relative to the icon's width and height, with [0, 0] at the top left and [1, 1] at the bottom right.
`airplaneIconSize`	`number`	The size of the player airplane icon, in pixels.
`airplaneIconSrc`	`string` \| `Subscribable`<`string`>	The URI of the player airplane icon's image asset
`altitudeModeText?`	`Partial`<`Record`<`MapTrafficAltitudeRestrictionMode`, `string`>>	The text to display in the altitude restriction mode indicator for each operating mode. Ignored if `includeAltitudeModeIndicator` is `false`.
`configureFlightPlan?`	(`builder`: `MapWaypointDisplayBuilder`) => `void`	A function which configures the display of flight plan waypoints. Required to display the active flight plan.
`dataUpdateFreq`	`number` \| `Subscribable`<`number`>	The frequency, in hertz, with which the player airplane's properties are updated from event bus data.
`flightPathRenderer?`	`MapFlightPathPlanRenderer`	The flight path renderer to use to render the active plan. Required to display the active flight plan.
`flightPlanner?`	`FlightPlanner` \| `Subscribable`<`FlightPlanner`>	The flight planner containing the active flight plan. Required to display the active flight plan.
`iconFactory?`	`MapTrafficIntruderIconFactory`	A function which creates intruder icons for the traffic display. If not defined, a default icon of type MapTrafficIntruderIcon is created for each intruder.
`includeAdsbModeIndicator?`	`boolean`	Whether to include an ADS-B operating mode indicator. Defaults to `true`. Ignored if ADS-B is not supported.
`includeAdsbOffBanner?`	`boolean`	Whether to include an ADS-B standby mode warning banner. Defaults to `true`. Ignored if ADS-B is not supported.
`includeAltitudeModeIndicator?`	`boolean`	Whether to include an altitude restriction mode indicator. Defaults to `true`.
`includeFailedBanner?`	`boolean`	Whether to include a traffic system failed mode warning banner. Defaults to `true`.
`includeOperatingModeIndicator?`	`boolean`	Whether to include a traffic system operating mode indicator. Defaults to `true`.
`includeOrientationIndicator?`	`boolean`	Whether to include an orientation indicator. Defaults to `true`.
`includeRangeRings`	`boolean`	Whether to include range rings.
`includeStandbyBanner?`	`boolean`	Whether to include a traffic system standby mode warning banner. Defaults to `true`.
`initCanvasStyles?`	(`context`: `CanvasRenderingContext2D`) => `void`	A function which initializes global canvas styles for the traffic display.
`lnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the LNAV from which to source data. Defaults to `0`.
`mapRangeSettingManager?`	`UserSettingManager`<`TrafficMapRangeControllerSettings`>	A user setting manager containing the map range setting. If not defined, map range will not be controlled by user setting.
`metricRangeArray?`	readonly `NumberUnitInterface`<`UnitFamily.Distance`>[]	The map range array to use for metric units mode. If not defined, a range array will not automatically be set when entering metric units mode.
`miniCompassImgSrc?`	`string`	The URI of the mini-compass's image asset. Required to display the mini-compass.
`nauticalRangeArray?`	readonly `NumberUnitInterface`<`UnitFamily.Distance`>[]	The map range array to use for nautical units mode. If not defined, a range array will not automatically be set when entering nautical units mode.
`offScaleStatus?`	`MutableSubscribable`<`MapTrafficOffScaleStatus`>	A mutable subscribable to update with the traffic layer's off-scale intruder status.
`operatingModeText?`	`Partial`<`Record`<`TcasOperatingMode`, `string`>>	The text to display in the traffic system operating mode indicator for each operating mode. Ignored if `includeOperatingModeIndicator` is `false`.
`orientation`	`MapOrientation` \| `Subscribable`<`MapOrientation`>	The orientation of the map.
`orientationText?`	`Partial`<`Record`<`MapOrientation`, `string`>>	The text to display in the orientation indicator for each orientation mode. Ignored if `includeOrientationIndicator` is `false`.
`rangeEndpoints?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The nominal range endpoints of the map, as `[x1, y1, x2, y2]`, where each component is expressed relative to the width or height of the map's projected window, excluding the dead zone. Defaults to `[0.5, 0.5, 0.5, 0]`.
`rangeRingOptions?`	`TrafficRangeRingOptions`	Styling options for the range rings. If not defined, both the outer and inner label radial values are set to 135 degrees. Ignored if `includeRangeRings` is `false`.
`supportDataIntegrity?`	`boolean`	Whether to support data integrity state. Defaults to `true`.
`targetOffset?`	`ReadonlyFloat64Array` \| `Subscribable`<`ReadonlyFloat64Array`>	The nominal projected target offset of the map, as `[x, y]`, where each component is expressed relative to the width or height of the map's projected window, excluding the dead zone. Defaults to `[0, 0]`.
`trafficIconOptions`	`TrafficIconOptions`	Configuration options for traffic icons.
`trafficSettingManager?`	`UserSettingManager`<`Partial`<`TrafficUserSettingTypes`>>	A user setting manager containing settings controlling the operation of the traffic system.
`trafficSystem`	`TrafficSystem`	The traffic system from which to retrieve intruder data.
`unitsSettingManager?`	`UnitsUserSettingManager`	A display units user setting manager. If not defined, map display units will not be controlled by user settings.
`useRangeSettingByDefault?`	`boolean`	Whether to use the map range user setting to control map range by default. Defaults to `true`. Ignored if `mapRangeSettingManager` is not defined.
`vnavIndex?`	`number` \| `Subscribable`<`number`>	The index of the VNAV from which to source data. Defaults to `0`.

Defined in

src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:33

TrafficMapRangeControllerSettings

Ƭ TrafficMapRangeControllerSettings: Object

User settings required by MapTrafficRangeController.

Type declaration

Name	Type	Description
`mapRangeIndex`	`number`	The range setting.

Defined in

src/garminsdk/components/map/controllers/TrafficMapRangeController.ts:28

TrafficMapRangeLabelRenderer

Ƭ TrafficMapRangeLabelRenderer: (range: Subscribable<NumberUnitInterface<UnitFamily.Distance>>, displayUnit: Subscribable<Unit<UnitFamily.Distance>>) => VNode

A function which renders labels for traffic map range rings.

Type declaration

▸ (range, displayUnit): VNode

Parameters

Name	Type
`range`	`Subscribable`<`NumberUnitInterface`<`UnitFamily.Distance`>>
`displayUnit`	`Subscribable`<`Unit`<`UnitFamily.Distance`>>

Returns

TypeOfNavDataFieldModel

Ƭ TypeOfNavDataFieldModel<M>: M extends NavDataFieldModel<infer T> ? T : never

Utility type to get the value type from a NavDataFieldModel type.

Type parameters

Name	Type
`M`	extends `NavDataFieldModel`<`any`>

Defined in

src/garminsdk/components/navdatafield/NavDataFieldModel.ts:14

UnitsUserSettingTypes

Ƭ UnitsUserSettingTypes: Object

Garmin display units user settings.

Type declaration

Name	Type	Description
`unitsAltitude`	`UnitsAltitudeSettingMode`	The altitude units setting.
`unitsDistance`	`UnitsDistanceSettingMode`	The distance/speed units setting.
`unitsFuel`	`UnitsFuelSettingMode`	The fuel units setting.
`unitsNavAngle`	`UnitsNavAngleSettingMode`	The nav angle units setting.
`unitsTemperature`	`UnitsTemperatureSettingMode`	The temperature units setting.
`unitsWeight`	`UnitsWeightSettingMode`	The weight units setting.

Defined in

src/garminsdk/settings/UnitsUserSettings.ts:62

VNavDataEvents

Ƭ VNavDataEvents: GarminVNavDataEvents

Events related to Garmin VNAV data.

Deprecated

Defined in

src/garminsdk/autopilot/vnav/GarminVNavDataEvents.ts:58

VNavTargetAltitudeRestriction

Ƭ VNavTargetAltitudeRestriction: Object

A VNAV target altitude restriction.

Type declaration

Name	Type	Description
`altitude`	`number`	The altitude for this restriction, in feet.
`type`	`VNavTargetAltitudeRestrictionType`	The type of this restriction.

Defined in

src/garminsdk/navigation/VNavDataProvider.ts:21

VNavTargetAltitudeRestrictionType

Ƭ VNavTargetAltitudeRestrictionType: Exclude<AltitudeRestrictionType, AltitudeRestrictionType.Between | AltitudeRestrictionType.Unused>

▪ [defaultValue: `vSpeedDefaultValue_${string}`]: number

src/garminsdk/components/map/GarminMapBuilder.tsx:119

WaypointInfoStoreOptions

Ƭ WaypointInfoStoreOptions: Object

Configuration options for WaypointInfoStore.

Type declaration

Name	Type	Description
`useRegionFallbackForAirport?`	`boolean`	Whether to fall back to using an airport's city name for region text if the airport's region cannot be found. Defaults to `true`.

Defined in

src/garminsdk/navigation/WaypointInfoStore.ts:12

WeatherMapOrientationControllerSettings

Ƭ WeatherMapOrientationControllerSettings: Pick<MapUserSettingTypes & WeatherMapUserSettingTypes, "weatherMapOrientation" | "mapOrientation" | "mapAutoNorthUpActive" | "mapAutoNorthUpRangeIndex">

src/garminsdk/settings/WeatherMapUserSettings.ts:15

WeatherRadarUserSettingTypes

Ƭ WeatherRadarUserSettingTypes: Object

Weather radar user settings.

Type declaration

Name	Type	Description
`wxrActive`	`boolean`	Whether the weather radar is active.
`wxrCalibratedGain`	`boolean`	Whether the weather radar's gain should be locked to the calibrated setting (0 dBZ).
`wxrGain`	`number`	The weather radar's gain, in dBZ.
`wxrOperatingMode`	`WeatherRadarOperatingMode`	The weather radar's operating mode.
`wxrRangeIndex`	`number`	The index of the weather radar's current range.
`wxrScanMode`	`WeatherRadarScanMode`	The weather radar's scan mode.
`wxrShowBearingLine`	`boolean`	Whether to show the bearing line in horizontal scan mode.
`wxrShowTiltLine`	`boolean`	Whether to show the tilt line in vertical scan mode.

Defined in

src/garminsdk/settings/WeatherRadarUserSettings.ts:6

Enumerations
Classes
Interfaces
Type Aliases

Enumerations​

Classes​

Interfaces​

Type Aliases​

APExternalGuidanceProviderOptions​

Type declaration​

Defined in​

ActiveFlightPlanOptions​

Type declaration​

Defined in​

AdcSystemSelectionState​

Defined in​

AdcSystemSelectorOptions​

Type declaration​

Defined in​

AhrsSystemSelectionState​

Defined in​

AhrsSystemSelectorOptions​

Type declaration​

Defined in​

AircraftSymbolOptions​

Defined in​

AirspeedAlertOptions​

Type declaration​

Defined in​

AirspeedDefinitionContext​

Type declaration​

Defined in​

AirspeedDefinitionFactory​

Type declaration​

Parameters​

Returns​

Defined in​

AirspeedIndicatorBottomDisplayOptions​

Type declaration​

Defined in​

AirspeedIndicatorColorRange​

Type declaration​

Defined in​

AirspeedIndicatorDataProviderOptions​

Type declaration​

Defined in​

AirspeedTapeScaleOptions​

Defined in​

AirspeedTrendVectorOptions​

Defined in​

AltimeterDataProviderOptions​

Type declaration​

Defined in​

AltimeterTapeScaleOptions​

Defined in​

AltimeterTrendVectorOptions​

Defined in​

AltimeterUserSettingTypes​

Defined in​

AltitudeArcOptions​

Defined in​

ApproachDetails​

Type declaration​

Defined in​

ApproachListItem​

Type declaration​

Defined in​

ApproachNameParts​

Type declaration​

Defined in​

ArtificialHorizonColorStop​

Defined in​

ArtificialHorizonSkyColor​

Defined in​

AttitudeAircraftSymbolColor​

Defined in​

BaseIndexedGarminTimerControlEvents​

Type declaration​

Defined in​

BaseNavDataFieldTypeRendererOptions​

Type declaration​

Defined in​

BaseNonIndexedGarminTimerControlEvents​

Type declaration​

Enumerations

Classes

Interfaces

Type Aliases

APExternalGuidanceProviderOptions

Type declaration

Defined in

ActiveFlightPlanOptions

Type declaration

Defined in

AdcSystemSelectionState

Defined in

AdcSystemSelectorOptions

Type declaration

Defined in

AhrsSystemSelectionState

Defined in

AhrsSystemSelectorOptions

Type declaration

Defined in

AircraftSymbolOptions

Defined in

AirspeedAlertOptions

Type declaration

Defined in

AirspeedDefinitionContext

Type declaration

Defined in

AirspeedDefinitionFactory

Type declaration

Parameters

Returns

Defined in

AirspeedIndicatorBottomDisplayOptions

Type declaration

Defined in

AirspeedIndicatorColorRange

Type declaration

Defined in

AirspeedIndicatorDataProviderOptions

Type declaration

Defined in

AirspeedTapeScaleOptions

Defined in

AirspeedTrendVectorOptions

Defined in

AltimeterDataProviderOptions

Type declaration

Defined in

AltimeterTapeScaleOptions

Defined in

AltimeterTrendVectorOptions

Defined in

AltimeterUserSettingTypes

Defined in

AltitudeArcOptions

Defined in

ApproachDetails

Type declaration

Defined in

ApproachListItem

Type declaration

Defined in

ApproachNameParts

Type declaration

Defined in

ArtificialHorizonColorStop

Defined in

ArtificialHorizonSkyColor

Defined in

AttitudeAircraftSymbolColor

Defined in

BaseIndexedGarminTimerControlEvents

Type declaration

Defined in

BaseNavDataFieldTypeRendererOptions

Type declaration

Defined in

BaseNonIndexedGarminTimerControlEvents

Type declaration