Type Alias: NextGenHsiMapOptions
NextGenHsiMapOptions =
object
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:36
Options for creating a next-generation (NXi, G3000, etc) Garmin HSI map.
Properties
airplaneIconAnchor
airplaneIconAnchor:
ReadonlyFloat64Array
|Subscribable
<ReadonlyFloat64Array
>
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:109
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/NextGenHsiMapBuilder.tsx:102
The size of the player airplane icon, in pixels.
airplaneIconSrc
airplaneIconSrc:
string
|Subscribable
<string
>
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:99
The URI of the player airplane icon's image asset
allowRelativeTerrainMode?
optional
allowRelativeTerrainMode:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:169
Whether to allow relative terrain mode. Defaults to true
. Ignored if useTerrainUserSettings
is false
or
settingManager
is not defined.
bingDelay?
optional
bingDelay:number
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:41
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/NextGenHsiMapBuilder.tsx:38
The ID to assign to the map's bound Bing Map instance.
dataUpdateFreq
dataUpdateFreq:
number
|Subscribable
<number
>
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:44
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/NextGenHsiMapBuilder.tsx:112
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/NextGenHsiMapBuilder.tsx:175
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/NextGenHsiMapBuilder.tsx:96
Whether to display airspaces. Defaults to true
.
includeAltitudeArc?
optional
includeAltitudeArc:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:130
Whether to include the altitude intercept arc display. Defaults to true
.
includeDetailIndicator?
optional
includeDetailIndicator:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:136
Whether to include a detail indicator. Defaults to true
.
includeRangeIndicator?
optional
includeRangeIndicator:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:133
Whether to include a map range indicator. Defaults to true
.
includeRunwayOutlines?
optional
includeRunwayOutlines:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:87
Whether to display airport runway outlines. Defaults to false
.
includeTrackVector?
optional
includeTrackVector:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:127
Whether to include the track vector display. Defaults to true
.
includeTrafficOffScaleIndicator?
optional
includeTrafficOffScaleIndicator:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:139
Whether to include a traffic off-scale status indicator. Defaults to true
.
includeTrafficStatusIndicator?
optional
includeTrafficStatusIndicator:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:142
Whether to include a traffic status indicator. Defaults to true
.
lnavIndex?
optional
lnavIndex:number
|Subscribable
<number
>
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:115
The index of the LNAV from which to source data. Defaults to 0
.
metricRangeArray?
optional
metricRangeArray: readonlyNumberUnitInterface
<UnitFamily.Distance
>[]
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:71
The map range array to use for metric units mode. Defaults to a standard range array.
nauticalRangeArray?
optional
nauticalRangeArray: readonlyNumberUnitInterface
<UnitFamily.Distance
>[]
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:68
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/NextGenHsiMapBuilder.tsx:180
The minimum range index, inclusive, at which NEXRAD is visible.
noHeadingAirplaneIconAnchor?
optional
noHeadingAirplaneIconAnchor:ReadonlyFloat64Array
|Subscribable
<ReadonlyFloat64Array
>
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:84
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/NextGenHsiMapBuilder.tsx:77
The URI of the no-heading player airplane icon's image asset, or a subscribable which provides it.
rangeEndpoints?
optional
rangeEndpoints:ReadonlyFloat64Array
|Subscribable
<ReadonlyFloat64Array
>
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:65
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]
.
runwayDesignationImageCache?
optional
runwayDesignationImageCache:MapRunwayDesignationImageCache
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:93
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/NextGenHsiMapBuilder.tsx:148
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/NextGenHsiMapBuilder.tsx:74
Whether to support data integrity state. Defaults to true
.
targetOffset?
optional
targetOffset:ReadonlyFloat64Array
|Subscribable
<ReadonlyFloat64Array
>
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:59
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?
optional
trafficIconOptions:NextGenHsiMapTrafficIconOptions
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:124
Configuration options for traffic icons. Required to display traffic.
trafficSettingManager?
optional
trafficSettingManager:UserSettingManager
<Partial
<TrafficUserSettingTypes
>>
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:154
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/NextGenHsiMapBuilder.tsx:121
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/NextGenHsiMapBuilder.tsx:157
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/NextGenHsiMapBuilder.tsx:204
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/NextGenHsiMapBuilder.tsx:216
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/NextGenHsiMapBuilder.tsx:192
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/NextGenHsiMapBuilder.tsx:186
Whether to bind the display of NEXRAD to user settings. Defaults to false
. Ignored if settingManager
is not
defined.
useRangeUserSettingByDefault?
optional
useRangeUserSettingByDefault:boolean
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:160
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/NextGenHsiMapBuilder.tsx:163
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/NextGenHsiMapBuilder.tsx:210
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/NextGenHsiMapBuilder.tsx:198
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/NextGenHsiMapBuilder.tsx:118
The index of the VNAV from which to source data. Defaults to 0
.
waypointIconImageCache
waypointIconImageCache:
WaypointIconImageCache
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:47
The image cache from which to retrieve waypoint icon images.
waypointStyleFontType
waypointStyleFontType:
"Roboto"
|"DejaVu"
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:50
The font type to use for waypoint labels.
waypointStyleScale?
optional
waypointStyleScale:number
Defined in: src/garminsdk/components/map/assembled/NextGenHsiMapBuilder.tsx:53
The scaling factor of waypoint icons and labels. Defaults to 1
.