Type Alias: NextGenNearestMapOptions
NextGenNearestMapOptions =
object
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:49
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:179
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?
optionalairplaneIconOrientation:MapOwnAirplaneIconOrientation|Subscribable<MapOwnAirplaneIconOrientation>
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:182
The orientation of the player airplane icon. Defaults to MapOwnAirplaneIconOrientation.HeadingUp.
airplaneIconSize
airplaneIconSize:
number
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:172
The size of the player airplane icon, in pixels.
airplaneIconSrc
airplaneIconSrc:
string|Subscribable<string>
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:169
The URI of the player airplane icon's image asset
allowRelativeTerrainMode?
optionalallowRelativeTerrainMode:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:295
Whether to allow relative terrain mode. Defaults to false. Ignored if useTerrainUserSettings is false or
settingManager is not defined.
bingDelay?
optionalbingDelay:number
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:57
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:54
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/NextGenNearestMapBuilder.tsx:65
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.
defaultNoTargetRangeIndex?
optionaldefaultNoTargetRangeIndex:number|Subscribable<number> |null
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:74
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.
facilityLoader?
optionalfacilityLoader:FacilityLoader
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:51
The facility loader to use. If not defined, then a default instance will be created.
flightPlanner?
optionalflightPlanner:FlightPlanner
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:185
The flight planner containing the active flight plan. Required to display the active flight plan.
groundRelativeTerrainBlendDuration?
optionalgroundRelativeTerrainBlendDuration:number
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:301
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?
optionalincludeAirspaces:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:166
Whether to display airspaces. Defaults to true.
includeAltitudeArc?
optionalincludeAltitudeArc:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:206
Whether to include the altitude intercept arc display. Defaults to true.
includeDetailIndicator?
optionalincludeDetailIndicator:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:238
Whether to include a detail indicator. Defaults to true.
includeOrientationIndicator?
optionalincludeOrientationIndicator:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:232
Whether to include an orientation indicator. Defaults to true.
includeRangeIndicator?
optionalincludeRangeIndicator:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:235
Whether to include a map range indicator. Defaults to false.
includeRunwayOutlines?
optionalincludeRunwayOutlines:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:149
Whether to display airport runway outlines. Defaults to false.
includeTerrainScale?
optionalincludeTerrainScale:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:250
Whether to include a terrain scale indicator. Defaults to true.
includeTrackVector?
optionalincludeTrackVector:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:203
Whether to include the track vector display. Defaults to true.
includeTrafficFailedIndicator?
optionalincludeTrafficFailedIndicator:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:247
Whether to include a traffic failed mode indicator. Defaults to true.
includeTrafficOffScaleIndicator?
optionalincludeTrafficOffScaleIndicator:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:244
Whether to include a traffic off-scale status indicator. Defaults to true.
includeTrafficStatusIndicator?
optionalincludeTrafficStatusIndicator:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:259
Whether to include a traffic status indicator. Defaults to true.
includeWindVector?
optionalincludeWindVector:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:209
Whether to include the wind vector display. Defaults to true. Ignored if windDataProvider is not defined.
lineOptions?
optionallineOptions:Readonly<WaypointHighlightLineOptions>
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:68
Styling options for the waypoint highlight line.
lnavIndex?
optionallnavIndex:number|Subscribable<number>
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:188
The index of the LNAV from which to source data. Defaults to 0.
metricRangeArray?
optionalmetricRangeArray: readonlyNumberUnitInterface<Distance>[]
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:124
The map range array to use for metric units mode. Defaults to a standard range array.
miniCompassImgSrc?
optionalminiCompassImgSrc:string
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:229
The URI of the mini-compass's image asset. Required to display the mini-compass.
nauticalRangeArray?
optionalnauticalRangeArray: readonlyNumberUnitInterface<Distance>[]
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:121
The map range array to use for nautical units mode. Defaults to a standard range array.
nexradMinRangeIndex?
optionalnexradMinRangeIndex:number
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:306
The minimum range index, inclusive, at which NEXRAD is visible.
noGpsBannerText?
optionalnoGpsBannerText:string
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:140
The text of the banner that is displayed when GPS position is not available. Defaults to 'NO GPS POSITION'.
noHeadingAirplaneIconAnchor?
optionalnoHeadingAirplaneIconAnchor:ReadonlyFloat64Array|Subscribable<ReadonlyFloat64Array>
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:137
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?
optionalnoHeadingAirplaneIconSrc:string|Subscribable<string>
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:130
The URI of the no-heading player airplane icon's image asset, or a subscribable which provides it.
pointerBoundsOffset?
optionalpointerBoundsOffset:ReadonlyFloat64Array|Subscribable<ReadonlyFloat64Array>
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:220
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?
optionalpointerInfoSize:MapPointerInfoLayerSize
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:226
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:146
Styling options for the range compass.
rangeEndpoints?
optionalrangeEndpoints:Partial<Record<MapOrientation,ReadonlyFloat64Array|Subscribable<ReadonlyFloat64Array>>>
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:118
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:143
Styling options for the range ring.
relativeTerrainStatusIndicatorIconPath?
optionalrelativeTerrainStatusIndicatorIconPath:string
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:256
The path to the relative terrain mode status indicator icon's image file. Required to include the relative terrain mode status indicator.
runwayDesignationImageCache?
optionalrunwayDesignationImageCache:MapRunwayDesignationImageCache
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:155
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?
optionalsettingManager:UserSettingManager<Partial<MapUserSettingTypes>>
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:271
A user setting manager containing map settings. If not defined, map options will not be controlled by user settings.
showDetailIndicatorTitle?
optionalshowDetailIndicatorTitle:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:241
Whether to show the detail indicator title. Defaults to true. Ignored if includeDetailIndicator is false.
showTrafficAltRestriction?
optionalshowTrafficAltRestriction:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:265
Whether to show the traffic altitude restriction mode on the traffic status indicator. Defaults to true. Ignored
if includeTrafficStatusIndicator is false.
supportDataIntegrity?
optionalsupportDataIntegrity:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:127
Whether to support data integrity state. Defaults to true.
supportWaypointHover?
optionalsupportWaypointHover:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:200
Whether to include support for hovered waypoints. Defaults to true.
targetOffsets?
optionaltargetOffsets:Partial<Record<MapOrientation,ReadonlyFloat64Array|Subscribable<ReadonlyFloat64Array>>>
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:104
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?
optionaltrafficIconOptions:NextGenNearestMapTrafficIconOptions
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:197
Configuration options for traffic icons. Required to display traffic.
trafficSettingManager?
optionaltrafficSettingManager:UserSettingManager<Partial<TrafficUserSettingTypes>>
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:277
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?
optionaltrafficSystem:TrafficSystem
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:194
The traffic system from which to retrieve traffic intruder data. Required to display traffic.
unitsSettingManager?
optionalunitsSettingManager:UnitsUserSettingManager
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:280
A display units user setting manager. If not defined, map display units will not be controlled by user settings.
useAirspaceVisUserSettings?
optionaluseAirspaceVisUserSettings:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:330
Whether to bind airspace visibility to user settings. Defaults to true. Ignored if settingManager is not
defined.
useAltitudeArcUserSettings?
optionaluseAltitudeArcUserSettings:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:342
Whether to bind altitude intercept arc options to user settings. Defaults to true. Ignored if settingManager
is not defined.
useDeclutterUserSetting?
optionaluseDeclutterUserSetting:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:318
Whether to bind the global declutter function to user settings. Defaults to true. Ignored if settingManager is
not defined.
useNexradUserSettings?
optionaluseNexradUserSettings:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:312
Whether to bind the display of NEXRAD to user settings. Defaults to false. Ignored if settingManager is not
defined.
useOrientationUserSettings?
optionaluseOrientationUserSettings:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:286
Whether to bind map orientation to user settings. Defaults to true. Ignored if settingManager is not defined.
useRangeUserSettingByDefault?
optionaluseRangeUserSettingByDefault:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:283
Whether the map's range should be controlled by user setting by default. Defaults to true.
userFacilityScopeFilter()?
optionaluserFacilityScopeFilter: (scope) =>boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:163
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
| Parameter | Type | Description |
|---|---|---|
scope | string | A user facility scope. |
Returns
boolean
Whether to display the user facility with the specified scope.
useTerrainUserSettings?
optionaluseTerrainUserSettings:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:289
Whether to bind terrain colors to user settings. Defaults to true. Ignored if settingManager is not defined.
useTrackVectorUserSettings?
optionaluseTrackVectorUserSettings:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:336
Whether to bind track vector options to user settings. Defaults to true. Ignored if settingManager is not
defined.
useWaypointVisUserSettings?
optionaluseWaypointVisUserSettings:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:324
Whether to bind waypoint visibility to user settings. Defaults to true. Ignored if settingManager is not
defined.
useWindVectorUserSettings?
optionaluseWindVectorUserSettings:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:348
Whether to bind wind vector options to user settings. Defaults to true. Ignored if settingManager is not
defined.
vnavIndex?
optionalvnavIndex:number|Subscribable<number>
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:191
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:77
The image cache from which to retrieve waypoint icon images.
waypointRendererAirportDataFlags?
optionalwaypointRendererAirportDataFlags:number
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:90
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/NextGenNearestMapBuilder.tsx:80
The font type to use for waypoint labels.
waypointStyleScale?
optionalwaypointStyleScale:number
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:83
The scaling factor of waypoint icons and labels. Defaults to 1.
windDataProvider?
optionalwindDataProvider:WindDataProvider
Defined in: src/garminsdk/components/map/assembled/NextGenNearestMapBuilder.tsx:212
A provider of wind data for the wind vector. Required to display the wind vector.