Skip to main content

Type Alias: NextGenWaypointMapOptions

NextGenWaypointMapOptions = object

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:31

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

Properties​

airplaneIconAnchor​

airplaneIconAnchor: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

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

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/NextGenWaypointMapBuilder.tsx:162

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

airplaneIconSize​

airplaneIconSize: number

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:152

The size of the player airplane icon, in pixels.

airplaneIconSrc​

airplaneIconSrc: string | Subscribable<string>

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:149

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

airportAutoRangeMargins?​

optional airportAutoRangeMargins: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:73

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

optional allowRelativeTerrainMode: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:215

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

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

dataUpdateFreq​

dataUpdateFreq: number | null | Subscribable<number | null>

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:47

The default frequency, in hertz, at which to update player airplane and autopilot properties from their bound data sources. If the frequency is null, then updates will not be throttled by frequency - each property will be updated as soon as the value of its data source changes. If the frequency is not null, then each property will only be updated when the map is updated, and the frequency of updates will not exceed updateFreq.

defaultAirportRangeIndex?​

optional defaultAirportRangeIndex: number | Subscribable<number>

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:66

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.

facilityLoader?​

optional facilityLoader: FacilityLoader

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

The facility loader to use. If not defined, then a default instance will be created.

flightPlanner?​

optional flightPlanner: FlightPlanner

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

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/NextGenWaypointMapBuilder.tsx:221

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

optional includeAirspaces: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:146

Whether to display airspaces. Defaults to false.

includeDetailIndicator?​

optional includeDetailIndicator: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:194

Whether to include a detail indicator. Defaults to false.

includeLine?​

optional includeLine: boolean

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

Whether the map draws a line from the highlighted waypoint to the player airplane. Defaults to false.

includeOrientationIndicator?​

optional includeOrientationIndicator: boolean

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

Whether to include an orientation indicator. Defaults to true.

includeRunwayOutlines?​

optional includeRunwayOutlines: boolean

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

Whether to display airport runway outlines. Defaults to false.

lineOptions?​

optional lineOptions: WaypointHighlightLineOptions

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:53

Styling options for the waypoint highlight line. Ignored if includeLine is false.

optional lnavIndex: number | Subscribable<number>

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

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

metricRangeArray?​

optional metricRangeArray: readonly NumberUnitInterface<Distance>[]

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

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/NextGenWaypointMapBuilder.tsx:188

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

nauticalRangeArray?​

optional nauticalRangeArray: readonly NumberUnitInterface<Distance>[]

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

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

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

noGpsBannerText?​

optional noGpsBannerText: string

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

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/NextGenWaypointMapBuilder.tsx:120

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/NextGenWaypointMapBuilder.tsx:113

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

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/NextGenWaypointMapBuilder.tsx:176

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

rangeEndpoints?​

optional rangeEndpoints: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

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

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

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

Styling options for the range ring.

runwayDesignationImageCache?​

optional runwayDesignationImageCache: MapRunwayDesignationImageCache

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.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/NextGenWaypointMapBuilder.tsx:203

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/NextGenWaypointMapBuilder.tsx:197

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

supportAirportAutoRange?​

optional supportAirportAutoRange: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:59

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

optional supportDataIntegrity: boolean

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

Whether to support data integrity state. Defaults to true.

targetOffset?​

optional targetOffset: ReadonlyFloat64Array | Subscribable<ReadonlyFloat64Array>

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

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

optional unitsSettingManager: UnitsUserSettingManager

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:206

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/NextGenWaypointMapBuilder.tsx:250

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

useDeclutterUserSetting?​

optional useDeclutterUserSetting: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:238

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

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

userFacilityScopeFilter()?​

optional userFacilityScopeFilter: (scope) => boolean

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:143

A function that filters user facilities to be displayed by the nearest waypoints layer based on their scopes. If not defined, then user facilities will not be filtered based on scope.

Parameters​

ParameterTypeDescription
scopestringA user facility scope.

Returns​

boolean

Whether to display the user facility with the specified scope.

useTerrainUserSettings?​

optional useTerrainUserSettings: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:209

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

useWaypointVisUserSettings?​

optional useWaypointVisUserSettings: boolean

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:244

Whether to bind waypoint visibility 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/NextGenWaypointMapBuilder.tsx:185

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

waypointIconImageCache​

waypointIconImageCache: WaypointIconImageCache

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:76

The image cache from which to retrieve waypoint icon images.

waypointRendererAirportDataFlags?​

optional waypointRendererAirportDataFlags: number

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

Bitflags describing the requested data to be loaded in airport facilities retrieved by the map for rendering purposes. This controls what data are available from airport waypoints registered with the map's waypoint renderer. Defaults to NextGenGarminMapUtils.AIRPORT_DATA_FLAGS.

waypointStyleFontType​

waypointStyleFontType: "Roboto" | "DejaVu"

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

The font type to use for waypoint labels.

waypointStyleScale?​

optional waypointStyleScale: number

Defined in: src/garminsdk/components/map/assembled/NextGenWaypointMapBuilder.tsx:82

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