Skip to main content

Type Alias: NextGenConnextMapOptions

NextGenConnextMapOptions = object

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:34

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

Properties​

airplaneIconAnchor​

airplaneIconAnchor: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

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

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/NextGenConnextMapBuilder.tsx:125

The size of the player airplane icon, in pixels.

airplaneIconSrc​

airplaneIconSrc: string | Subscribable<string>

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:122

The URI of the player airplane icon's image asset

bingDelay?​

optional bingDelay: number

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:39

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/NextGenConnextMapBuilder.tsx:36

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

dataUpdateFreq​

dataUpdateFreq: number | Subscribable<number>

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:42

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

flightPlanner?​

optional flightPlanner: FlightPlanner

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

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

includeAirspaces?​

optional includeAirspaces: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:119

Whether to display airspaces. Defaults to true.

includeAltitudeArc?​

optional includeAltitudeArc: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:147

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

includeOrientationIndicator?​

optional includeOrientationIndicator: boolean

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

Whether to include an orientation indicator. Defaults to true.

includeRangeIndicator?​

optional includeRangeIndicator: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:176

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

includeRunwayOutlines?​

optional includeRunwayOutlines: boolean

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

Whether to display airport runway outlines. Defaults to false.

includeTrackVector?​

optional includeTrackVector: boolean

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

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

includeWindVector?​

optional includeWindVector: boolean

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

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

optional lnavIndex: number | Subscribable<number>

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

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/NextGenConnextMapBuilder.tsx:85

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/NextGenConnextMapBuilder.tsx:170

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/NextGenConnextMapBuilder.tsx:82

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

noGpsBannerText?​

optional noGpsBannerText: string

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:101

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/NextGenConnextMapBuilder.tsx:98

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/NextGenConnextMapBuilder.tsx:91

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/NextGenConnextMapBuilder.tsx:161

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/NextGenConnextMapBuilder.tsx:167

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

radarOverlayMinRangeIndex?​

optional radarOverlayMinRangeIndex: number

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:196

The minimum range index, inclusive, at which the radar overlay is visible.

rangeCompassOptions​

rangeCompassOptions: RangeCompassOptions

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

Styling options for the range compass.

rangeEndpoints?​

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

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:79

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/NextGenConnextMapBuilder.tsx:104

Styling options for the range ring.

runwayDesignationImageCache?​

optional runwayDesignationImageCache: MapRunwayDesignationImageCache

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:116

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 & WeatherMapUserSettingTypes>>

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

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

supportDataIntegrity?​

optional supportDataIntegrity: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:88

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/NextGenConnextMapBuilder.tsx:65

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]
}

unitsSettingManager?​

optional unitsSettingManager: UnitsUserSettingManager

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:185

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/NextGenConnextMapBuilder.tsx:214

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/NextGenConnextMapBuilder.tsx:226

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

useOrientationUserSettings?​

optional useOrientationUserSettings: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:191

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

useRadarOverlayUserSettings?​

optional useRadarOverlayUserSettings: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:202

Whether to bind the display of the radar overlay to user settings. Defaults to true. Ignored if settingManager is not defined.

useRangeUserSettingByDefault?​

optional useRangeUserSettingByDefault: boolean

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

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

useTrackVectorUserSettings?​

optional useTrackVectorUserSettings: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:220

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/NextGenConnextMapBuilder.tsx:208

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/NextGenConnextMapBuilder.tsx:232

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/NextGenConnextMapBuilder.tsx:141

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

waypointIconImageCache​

waypointIconImageCache: WaypointIconImageCache

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:45

The image cache from which to retrieve waypoint icon images.

waypointStyleFontType​

waypointStyleFontType: "Roboto" | "DejaVu"

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:48

The font type to use for waypoint labels.

waypointStyleScale?​

optional waypointStyleScale: number

Defined in: src/garminsdk/components/map/assembled/NextGenConnextMapBuilder.tsx:51

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

windDataProvider?​

optional windDataProvider: WindDataProvider

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

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