Skip to main content

Type Alias: TrafficMapOptions

TrafficMapOptions = object

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

Options for creating a Garmin traffic map.

Properties​

adsbModeText?​

optional adsbModeText: Partial<Record<AdsbOperatingMode, string>>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:150

The text to display in the ADS-B operating mode indicator for each operating mode. Ignored if ADS-B is not supported.

airplaneIconAnchor​

airplaneIconAnchor: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:102

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​

airplaneIconSize: number

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:95

The size of the player airplane icon, in pixels.

airplaneIconSrc​

airplaneIconSrc: string | Subscribable<string>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:92

The URI of the player airplane icon's image asset

altitudeModeText?​

optional altitudeModeText: Partial<Record<MapTrafficAltitudeRestrictionMode, string>>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:159

The text to display in the altitude restriction mode indicator for each operating mode. Ignored if includeAltitudeModeIndicator is false.

configureFlightPlan()?​

optional configureFlightPlan: (builder) => void

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:117

A function which configures the display of flight plan waypoints. Required to display the active flight plan.

Parameters​

ParameterType
builderMapWaypointDisplayBuilder

Returns​

void

dataUpdateFreq​

dataUpdateFreq: number | Subscribable<number>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:38

The frequency, in hertz, with which the player airplane's properties are updated from event bus data.

flightPathRenderer?​

optional flightPathRenderer: MapFlightPathPlanRenderer

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:114

The flight path renderer to use to render the active plan. Required to display the active flight plan.

flightPlanner?​

optional flightPlanner: FlightPlanner | Subscribable<FlightPlanner>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:105

The flight planner containing the active flight plan. Required to display the active flight plan.

iconFactory?​

optional iconFactory: MapTrafficIntruderIconFactory

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:77

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?​

optional includeAdsbModeIndicator: boolean

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:144

Whether to include an ADS-B operating mode indicator. Defaults to true. Ignored if ADS-B is not supported.

includeAdsbOffBanner?​

optional includeAdsbOffBanner: boolean

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:165

Whether to include an ADS-B standby mode warning banner. Defaults to true. Ignored if ADS-B is not supported.

includeAltitudeModeIndicator?​

optional includeAltitudeModeIndicator: boolean

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:153

Whether to include an altitude restriction mode indicator. Defaults to true.

includeFailedBanner?​

optional includeFailedBanner: boolean

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:168

Whether to include a traffic system failed mode warning banner. Defaults to true.

includeOperatingModeIndicator?​

optional includeOperatingModeIndicator: boolean

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:135

Whether to include a traffic system operating mode indicator. Defaults to true.

includeOrientationIndicator?​

optional includeOrientationIndicator: boolean

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:126

Whether to include an orientation indicator. Defaults to true.

includeRangeRings​

includeRangeRings: boolean

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:83

Whether to include range rings.

includeStandbyBanner?​

optional includeStandbyBanner: boolean

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:162

Whether to include a traffic system standby mode warning banner. Defaults to true.

initCanvasStyles()?​

optional initCanvasStyles: (context) => void

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:80

A function which initializes global canvas styles for the traffic display.

Parameters​

ParameterType
contextCanvasRenderingContext2D

Returns​

void

optional lnavIndex: number | Subscribable<number>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:108

The index of the LNAV from which to source data. Defaults to 0.

mapRangeSettingManager?​

optional mapRangeSettingManager: UserSettingManager<TrafficMapRangeControllerSettings>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:179

A user setting manager containing the map range setting. If not defined, map range will not be controlled by user setting.

metricRangeArray?​

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

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:62

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?​

optional miniCompassImgSrc: string

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:120

The URI of the mini-compass's image asset. Required to display the mini-compass.

nauticalRangeArray?​

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

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:56

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?​

optional offScaleStatus: MutableSubscribable<MapTrafficOffScaleStatus>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:71

A mutable subscribable to update with the traffic layer's off-scale intruder status.

operatingModeText?​

optional operatingModeText: Partial<Record<TcasOperatingMode, string>>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:141

The text to display in the traffic system operating mode indicator for each operating mode. Ignored if includeOperatingModeIndicator is false.

orientation​

orientation: MapOrientation | Subscribable<MapOrientation>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:123

The orientation of the map.

orientationText?​

optional orientationText: Partial<Record<MapOrientation, string>>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:132

The text to display in the orientation indicator for each orientation mode. Ignored if includeOrientationIndicator is false.

rangeEndpoints?​

optional rangeEndpoints: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:50

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?​

optional rangeRingOptions: TrafficRangeRingOptions

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:89

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?​

optional supportDataIntegrity: boolean

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:65

Whether to support data integrity state. Defaults to true.

targetOffset?​

optional targetOffset: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:44

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

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:68

Configuration options for traffic icons.

trafficSettingManager?​

optional trafficSettingManager: UserSettingManager<Partial<TrafficUserSettingTypes>>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:173

A user setting manager containing settings controlling the operation of the traffic system.

trafficSystem​

trafficSystem: TrafficSystem

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:35

The traffic system from which to retrieve intruder data.

unitsSettingManager?​

optional unitsSettingManager: UnitsUserSettingManager

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:182

A display units user setting manager. If not defined, map display units will not be controlled by user settings.

useRangeSettingByDefault?​

optional useRangeSettingByDefault: boolean

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:188

Whether to use the map range user setting to control map range by default. Defaults to true. Ignored if mapRangeSettingManager is not defined.

vnavIndex?​

optional vnavIndex: number | Subscribable<number>

Defined in: src/garminsdk/components/map/assembled/TrafficMapBuilder.tsx:111

The index of the VNAV from which to source data. Defaults to 0.