Skip to main content

Type Alias: NextGenNearestMapOptions

NextGenNearestMapOptions = object

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

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

Properties​

airplaneIconAnchor​

airplaneIconAnchor: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:151

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

optional airplaneIconOrientation: MapOwnAirplaneIconOrientation | Subscribable<MapOwnAirplaneIconOrientation>

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:154

The orientation of the player airplane icon. Defaults to MapOwnAirplaneIconOrientation.HeadingUp.

airplaneIconSize​

airplaneIconSize: number

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

The size of the player airplane icon, in pixels.

airplaneIconSrc​

airplaneIconSrc: string | Subscribable<string>

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

The URI of the player airplane icon's image asset

allowRelativeTerrainMode?​

optional allowRelativeTerrainMode: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:264

Whether to allow relative terrain mode. Defaults to false. Ignored if useTerrainUserSettings is false or settingManager is not defined.

bingDelay?​

optional bingDelay: number

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:49

The amount of time, in milliseconds, to delay binding the map's Bing Map instance. Defaults to 0.

bingId​

bingId: string

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:46

The ID to assign to the map's bound Bing Map instance.

dataUpdateFreq​

dataUpdateFreq: number | Subscribable<number>

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:52

The frequency, in hertz, with which player airplane and autopilot properties are updated from event bus data.

defaultNoTargetRangeIndex?​

optional defaultNoTargetRangeIndex: number | Subscribable<number> | null

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:61

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

optional flightPlanner: FlightPlanner

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:157

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

groundRelativeTerrainBlendDuration?​

optional groundRelativeTerrainBlendDuration: number

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:270

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

optional includeAirspaces: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:138

Whether to display airspaces. Defaults to true.

includeAltitudeArc?​

optional includeAltitudeArc: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:175

Whether to include the altitude intercept arc display. Defaults to true.

includeDetailIndicator?​

optional includeDetailIndicator: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:207

Whether to include a detail indicator. Defaults to true.

includeOrientationIndicator?​

optional includeOrientationIndicator: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:201

Whether to include an orientation indicator. Defaults to true.

includeRangeIndicator?​

optional includeRangeIndicator: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:204

Whether to include a map range indicator. Defaults to false.

includeRunwayOutlines?​

optional includeRunwayOutlines: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:129

Whether to display airport runway outlines. Defaults to false.

includeTerrainScale?​

optional includeTerrainScale: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:219

Whether to include a terrain scale indicator. Defaults to true.

includeTrackVector?​

optional includeTrackVector: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:172

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

includeTrafficFailedIndicator?​

optional includeTrafficFailedIndicator: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:216

Whether to include a traffic failed mode indicator. Defaults to true.

includeTrafficOffScaleIndicator?​

optional includeTrafficOffScaleIndicator: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:213

Whether to include a traffic off-scale status indicator. Defaults to true.

includeTrafficStatusIndicator?​

optional includeTrafficStatusIndicator: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:228

Whether to include a traffic status indicator. Defaults to true.

includeWindVector?​

optional includeWindVector: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:178

Whether to include the wind vector display. Defaults to true. Ignored if windDataProvider is not defined.

lineOptions?​

optional lineOptions: Readonly<WaypointHighlightLineOptions>

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:55

Styling options for the waypoint highlight line.

optional lnavIndex: number | Subscribable<number>

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:160

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

metricRangeArray?​

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

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:104

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

miniCompassImgSrc?​

optional miniCompassImgSrc: string

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:198

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/NextGenNearestMapBuilder.tsx:101

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

nexradMinRangeIndex?​

optional nexradMinRangeIndex: number

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:275

The minimum range index, inclusive, at which NEXRAD is visible.

noGpsBannerText?​

optional noGpsBannerText: string

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

The text of the banner that is displayed when GPS position is not available. Defaults to 'NO GPS POSITION'.

noHeadingAirplaneIconAnchor?​

optional noHeadingAirplaneIconAnchor: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

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

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

optional noHeadingAirplaneIconSrc: string | Subscribable<string>

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:110

The URI of the no-heading player airplane icon's image asset, or a subscribable which provides it.

pointerBoundsOffset?​

optional pointerBoundsOffset: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:189

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

optional pointerInfoSize: MapPointerInfoLayerSize

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:195

The size of the pointer information box. Required to display the pointer information box. Ignored if the map pointer is not supported.

rangeCompassOptions​

rangeCompassOptions: RangeCompassOptions

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

Styling options for the range compass.

rangeEndpoints?​

optional rangeEndpoints: Partial<Record<MapOrientation, ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>>>

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:98

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

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

Styling options for the range ring.

relativeTerrainStatusIndicatorIconPath?​

optional relativeTerrainStatusIndicatorIconPath: string

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:225

The path to the relative terrain mode status indicator icon's image file. Required to include the relative terrain mode status indicator.

runwayDesignationImageCache?​

optional runwayDesignationImageCache: MapRunwayDesignationImageCache

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

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

optional settingManager: UserSettingManager<Partial<MapUserSettingTypes>>

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:240

A user setting manager containing map settings. If not defined, map options will not be controlled by user settings.

showDetailIndicatorTitle?​

optional showDetailIndicatorTitle: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:210

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

showTrafficAltRestriction?​

optional showTrafficAltRestriction: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:234

Whether to show the traffic altitude restriction mode on the traffic status indicator. Defaults to true. Ignored if includeTrafficStatusIndicator is false.

supportDataIntegrity?​

optional supportDataIntegrity: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:107

Whether to support data integrity state. Defaults to true.

targetOffsets?​

optional targetOffsets: Partial<Record<MapOrientation, ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>>>

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:84

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

optional trafficIconOptions: NextGenNearestMapTrafficIconOptions

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:169

Configuration options for traffic icons. Required to display traffic.

trafficSettingManager?​

optional trafficSettingManager: UserSettingManager<Partial<TrafficUserSettingTypes>>

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:246

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

optional trafficSystem: TrafficSystem

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:166

The traffic system from which to retrieve traffic intruder data. Required to display traffic.

unitsSettingManager?​

optional unitsSettingManager: UnitsUserSettingManager

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:249

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

useAirspaceVisUserSettings?​

optional useAirspaceVisUserSettings: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:299

Whether to bind airspace visibility to user settings. Defaults to true. Ignored if settingManager is not defined.

useAltitudeArcUserSettings?​

optional useAltitudeArcUserSettings: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:311

Whether to bind altitude intercept arc options to user settings. Defaults to true. Ignored if settingManager is not defined.

useDeclutterUserSetting?​

optional useDeclutterUserSetting: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:287

Whether to bind the global declutter function to user settings. Defaults to true. Ignored if settingManager is not defined.

useNexradUserSettings?​

optional useNexradUserSettings: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:281

Whether to bind the display of NEXRAD to user settings. Defaults to false. Ignored if settingManager is not defined.

useOrientationUserSettings?​

optional useOrientationUserSettings: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:255

Whether to bind map orientation to user settings. Defaults to true. Ignored if settingManager is not defined.

useRangeUserSettingByDefault?​

optional useRangeUserSettingByDefault: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:252

Whether the map's range should be controlled by user setting by default. Defaults to true.

useTerrainUserSettings?​

optional useTerrainUserSettings: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:258

Whether to bind terrain colors to user settings. Defaults to true. Ignored if settingManager is not defined.

useTrackVectorUserSettings?​

optional useTrackVectorUserSettings: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:305

Whether to bind track vector options to user settings. Defaults to true. Ignored if settingManager is not defined.

useWaypointVisUserSettings?​

optional useWaypointVisUserSettings: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:293

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

useWindVectorUserSettings?​

optional useWindVectorUserSettings: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:317

Whether to bind wind vector options to user settings. Defaults to true. Ignored if settingManager is not defined.

vnavIndex?​

optional vnavIndex: number | Subscribable<number>

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:163

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

waypointIconImageCache​

waypointIconImageCache: WaypointIconImageCache

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:64

The image cache from which to retrieve waypoint icon images.

waypointStyleFontType​

waypointStyleFontType: "Roboto" | "DejaVu"

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:67

The font type to use for waypoint labels.

waypointStyleScale?​

optional waypointStyleScale: number

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:70

The scaling factor of waypoint icons and labels. Defaults to 1.

windDataProvider?​

optional windDataProvider: WindDataProvider

Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:181

A provider of wind data for the wind vector. Required to display the wind vector.